Interface IError

A schema validation error definition.

interface IError {
    data?: unknown;
    instancePath: string;
    keyword: string | string[];
    message?: string;
    params?: ReadonlyJSONObject;
    parentSchema?: unknown;
    propertyName?: string;
    schema?: unknown;
    schemaPath: string;
}

Properties

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

Properties

Optional data

data?: unknown

Todo

handle new fields from ajv8

instancePath

instancePath: string

Todo

handle new fields from ajv8

keyword

keyword: string | string[]

The keyword whose validation failed.

Optional message

message?: string

The error message.

Optional params

params?: ReadonlyJSONObject

Optional parameter metadata that might be included in an error.

Optional parentSchema

parentSchema?: unknown

Todo

handle new fields from ajv8

Optional propertyName

propertyName?: string

Todo

handle new fields from ajv8

Optional schema

schema?: unknown

Todo

handle new fields from ajv8

schemaPath

schemaPath: string

The path in the schema where the error occurred.

Settings

Member Visibility

Theme

On This Page

datainstancePathkeywordmessageparamsparentSchemapropertyNameschemaschemaPath