composite-validation/lib/types.d.ts

Composite validation API for JS data models

/**
 * Data model's value validity state.
 */
export declare class ValueState {
    name?: string;
    valid?: boolean;
    error?: string;
    isRequired?: boolean;
    /**
     * Creates instance of value state.
     * @param name Name of value.
     * @param valid Value is valid.
     * @param error Error message.
     * @param error Value is required.
     */
    constructor(name?: string, valid?: boolean, error?: string, isRequired?: boolean);
}
/**
 * Basic JavaScript type.
 */
export declare type BasicType = number | string | boolean | object;
/**
 * Validation function.
 */
export declare type ValidationFunction = (data: any, ...args: any[]) => any;
/**
 * Mixed validation function.
 */
export declare type MixedValidationFunction = ValidationFunction | Array<ValidationFunction> | VMap;
/**
 * Validation map for data model.
 */
export interface VMap {
    [key: string]: MixedValidationFunction;
}
/**
 * Wrapper for basic JavaScript type.
 */
export declare class WrappedValue {
    value: BasicType;
    isRequired: boolean;
    /**
     * Creates instance of wrapper.
     * @param value Inner wrapper value.
     * @param isRequired Value is required.
     */
    constructor(value: BasicType, isRequired: boolean);
}
/**
 * Data model's value validation error.
 */
export declare class ValueValidationError {
    error: string;
    isRequired: boolean;
    /**
     * Creates instance of error's object.
     * @param error Error message.
     * @param isRequired Value is required.
     */
    constructor(error: string, isRequired?: boolean);
}
//# sourceMappingURL=types.d.ts.map