@crow281/ts-file-module-template
    Preparing search index...

    Interface StandaloneErrorObject<K, P, S>

    Reports one of the reasons JSON Schema validation failed.

    This interface is a self-contained equivalent to ajv's ErrorObject and is used if the AJV library isn't available.

    interface StandaloneErrorObject<
        K extends string = string,
        P = Record<string, unknown>,
        S = unknown,
    > {
        data?: unknown;
        instancePath: string;
        keyword: K;
        message?: string;
        params: P;
        parentSchema?: Record<string, unknown>;
        propertyName?: string;
        schema?: S;
        schemaPath: string;
    }

    Type Parameters

    • K extends string = string

      Type of the object identifying the error.

    • P = Record<string, unknown>

      Type of the params property, containing data about the error.

    • S = unknown

      Type of the schema property, which if set, has a reference to the original schema object.

    Index

    Properties

    data? instancePath keyword message? params parentSchema? propertyName? schema? schemaPath

    Properties

    data?: unknown

    The data validated by the keyword.

    instancePath: string

    JSON Pointer to the location in the data instance (e.g. "/prop/1/subProp").

    keyword: K

    Validation keyword.

    message?: string

    The error message.

    params: P

    Object with additional information about error. It can be used to generate custom error messages, for example, in conjunction with the ajv-i18n package.

    See error parameters for more details.

    parentSchema?: Record<string, unknown>

    The object containing the keyword.

    propertyName?: string

    If error represented a "propertyNames" error, this is set to the propertyName that had the error.

    schema?: S

    The value of the failing keyword in the schema.

    Contains the original schema that triggered the error.

    schemaPath: string

    JSON Pointer to the location of the failing keyword in the schema.

    Settings

    Member Visibility

    On This Page

    Properties