Interface BaseIssue<TInput>

Base issue interface.

interface BaseIssue<TInput> {
    abortEarly?: boolean;
    abortPipeEarly?: boolean;
    expected: null | string;
    input: TInput;
    issues?: [BaseIssue<TInput>, ...BaseIssue<TInput>[]];
    kind: "schema" | "validation" | "transformation";
    lang?: string;
    message: string;
    path?: [IssuePathItem, ...IssuePathItem[]];
    received: string;
    requirement?: unknown;
    type: string;
}

Type Parameters

  • TInput

Hierarchy (View Summary)

Properties

abortEarly? abortPipeEarly? expected input issues? kind lang? message path? received requirement? type

Properties

Optional ReadonlyabortEarly

abortEarly?: boolean

Whether it should be aborted early.

Optional ReadonlyabortPipeEarly

abortPipeEarly?: boolean

Whether a pipe should be aborted early.

Readonlyexpected

expected: null | string

The expected property.

Readonlyinput

input: TInput

The raw input data.

Optional Readonlyissues

issues?: [BaseIssue<TInput>, ...BaseIssue<TInput>[]]

The sub issues.

Readonlykind

kind: "schema" | "validation" | "transformation"

The issue kind.

Optional Readonlylang

lang?: string

The selected language.

Readonlymessage

message: string

The error message.

Optional Readonlypath

path?: [IssuePathItem, ...IssuePathItem[]]

The issue path.

Readonlyreceived

received: string

The received property.

Optional Readonlyrequirement

requirement?: unknown

The input requirement.

Readonlytype

type: string

The issue type.

Settings

Member Visibility

On This Page

Properties