Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ValidationError

ValidationError represents a JSON Typedef validation error.

In terms of the formal JSON Typedef specification, ValidationError corresponds to a JSON Typedef error "indicator". ValidationError is not a subclass of Error. It is just a plain old TypeScript interface.

Both elements of ValidationError are meant to be used as the path segments of an RFC6901 JSON Pointer. This package does not provide an implementation of JSON Pointers for you, and you may choose to not use JSON Pointers at all.

Hierarchy

  • ValidationError

Index

Properties

instancePath

instancePath: string[]

instancePath is the path to a part of the instance, or "input", that was rejected.

schemaPath

schemaPath: string[]

schemaPath is the path to the part of the schema that rejected the input.

Generated using TypeDoc