@decaf-ts/decorator-validation/lib/validation/Validation.d.ts

simple decorator based validation engine

import { Validator } from "./Validators/Validator";
import { IValidatorRegistry, ValidatorDefinition } from "./types";
/**
 * @summary Static class acting as a namespace for the Validation
 *
 * @class Validation
 * @static
 *
 * @category Validation
 */
export declare class Validation {
    private static actingValidatorRegistry?;
    private static loadedDecorators;
    private constructor();
    /**
     * @summary Defines the acting ValidatorRegistry
     *
     * @param {IValidatorRegistry} validatorRegistry the new implementation of the validator Registry
     * @param {function(Validator): Validator} [migrationHandler] the method to map the validator if required;
     */
    static setRegistry(validatorRegistry: IValidatorRegistry<Validator>, migrationHandler?: (validator: Validator) => Validator): void;
    /**
     * @summary Returns the current ValidatorRegistry
     *
     * @return IValidatorRegistry, defaults to {@link ValidatorRegistry}
     */
    private static getRegistry;
    /**
     * @summary Retrieves a validator
     *
     * @param {string} validatorKey one of the {@link ValidationKeys}
     * @return {Validator | undefined} the registered Validator or undefined if there is nono matching the provided key
     */
    static get<T extends Validator>(validatorKey: string): T | undefined;
    /**
     * @summary Registers the provided validators onto the registry
     *
     * @param {T[] | ValidatorDefinition[]} validator
     */
    static register<T extends Validator>(...validator: (ValidatorDefinition | T)[]): void;
    /**
     * @summary Builds the key to store as Metadata under Reflections
     * @description concatenates {@link ValidationKeys#REFLECT} with the provided key
     *
     * @param {string} key
     */
    static key(key: string): string;
    /**
     * @summary Returns all registered validation keys
     */
    static keys(): string[];
    static registerDecorator(key: string, decorator: PropertyDecorator): void;
    static decoratorFromKey(key: string): PropertyDecorator;
}