Skip to main content

Interface: ValidationIssue

Defined in: packages/contracts/src/validation.ts:60

One reason a value failed. Never carries the offending value, which may be a secret.

Properties​

keyword​

readonly keyword: string

Defined in: packages/contracts/src/validation.ts:64

The Ajv keyword that failed, for example required or pattern.

message​

readonly message: string

Defined in: packages/contracts/src/validation.ts:66

What is wrong, without echoing the value.

params?​

readonly optional params?: IssueParams

Defined in: packages/contracts/src/validation.ts:68

The schema side of the failure, when the keyword has one; see IssueParams.

path​

readonly path: string

Defined in: packages/contracts/src/validation.ts:62

JSON Pointer to the failing location; empty for the root.