Amazon Vinyl
    Preparing search index...

    Interface Validator<Output, Input>

    A Validator can assert that an input matches this validator's schema.

    interface Validator<Output extends Input, in Input = unknown> {
        __type?: Invariant<Output>;
        assert: (
            input: Input,
            origin?: string,
            path?: readonly string[],
        ) => asserts input is Output;
        description: string;
        isValid: (input: Input) => input is Output;
        jsonSchema?: JsonSchema;
        validate: (
            input: Input,
            options?: ValidationOptions,
            path?: readonly string[],
        ) => readonly ValidationErrorMessage[];
    }

    Type Parameters

    • Output extends Input
    • in Input = unknown

    Hierarchy (View Summary)

    Index
    __type? assert description isValid jsonSchema? validate

    Optional__type

    __type?: Invariant<Output>

    Enforces T is in an invariant position. This prevents a validator with more strict rules is assigned to a less strict type, which can cause unexpected validation errors.

    assert: (
        input: Input,
        origin?: string,
        path?: readonly string[],
    ) => asserts input is Output

    Validates the given input, asserting that the input is type T. If the input is not valid, a ValidationError will be thrown.

    Type Declaration

      • (
            input: Input,
            origin?: string,
            path?: readonly string[],
        ): asserts input is Output

      • Parameters

        • input: Input

          The input to validate.

        • Optionalorigin: string

          The error origin. ErrorOrigin.API by default.

        • Optionalpath: readonly string[]

          The current field path to this validator.

        Returns asserts input is Output

        Returns the input, cast as the validated type T

    description: string

    A short description of the validator.

    isValid: (input: Input) => input is Output

    Returns true if the input is valid according to this validator.

    jsonSchema?: JsonSchema

    The JSON Schema fragment this validator contributes, if any.

    Fragments compose the same way the description does: chaining validators with and merges their fragments, and or unions them into an anyOf. Serialize a full schema with toJsonSchema. A validator with no meaningful shape (for example a bare type check) may omit this.

    validate: (
        input: Input,
        options?: ValidationOptions,
        path?: readonly string[],
    ) => readonly ValidationErrorMessage[]

    Validates the provided input, returning a list of error messages, or an empty array if the input passes this validator.

    Type Declaration

      • (
            input: Input,
            options?: ValidationOptions,
            path?: readonly string[],
        ): readonly ValidationErrorMessage[]

      • Parameters

        • input: Input

          The input to validate.

        • Optionaloptions: ValidationOptions

          Validation options.

        • Optionalpath: readonly string[]

          The current field path to this validator.

        Returns readonly ValidationErrorMessage[]

        Returns an array of validation failures. If options.all is not true, only the first error will be returned.

    Settings
    Member Visibility

    On This Page
    Properties