database-proxy/dist/policy/interface.d.ts

Through a set of access control rules configuration database access to realize the client directly access the database via HTTP.

import { Params } from '../types';
import { Handler, Processor } from '../processor';
import { AccessorInterface } from '../accessor';
export interface PermissionRule {
    [name: string]: Processor;
}
export interface ValidateError {
    type: string | number;
    error: string | object;
}
export interface ValidateResult {
    errors?: ValidateError[];
    matched?: PermissionRule;
}
/**
 * Ruler Interface
 */
export interface PolicyInterface {
    /**
     * collection names in rules
     * @readonly
     */
    collections: string[];
    /**
     * accessor
     * @readonly
     */
    accessor: AccessorInterface;
    /**
     * load all rules
     * @param rules json object roles
     */
    load(rules: any): boolean;
    /**
     * validate the request params
     * @param params
     * @param injections
     */
    validate(params: Params, injections: object): Promise<ValidateResult>;
    /**
     * register a validator for using in rules
     * @param name
     * @param handler
     */
    register(name: string, handler: Handler): void;
}
//# sourceMappingURL=interface.d.ts.map