express-validator/src/context.d.ts

Express middleware for the validator module.

import { FieldInstance, Location, Meta, ValidationError } from './base';
import { ContextItem } from './context-items';
export declare type Optional = {
    nullable: boolean;
    checkFalsy: boolean;
} | false;
export declare class Context {
    readonly fields: string[];
    readonly locations: Location[];
    readonly stack: ReadonlyArray<ContextItem>;
    readonly optional: Optional;
    readonly message?: any;
    private readonly _errors;
    readonly errors: ReadonlyArray<ValidationError>;
    private readonly dataMap;
    constructor(fields: string[], locations: Location[], stack: ReadonlyArray<ContextItem>, optional: Optional, message?: any);
    getData(options?: {
        requiredOnly: boolean;
    }): FieldInstance[];
    addFieldInstances(instances: FieldInstance[]): void;
    setData(path: string, value: any, location: Location): void;
    addError(message: any, value: any, meta: Meta): void;
    addError(message: any, nestedErrors: ValidationError[]): void;
}
export declare type ReadonlyContext = Pick<Context, Exclude<keyof Context, 'setData' | 'addFieldInstances' | 'addError'>>;