Class ValidationError

An error indicating that input had an invalid shape.

Hierarchy (View Summary)

ReportableError
- ValidationError

Index

Constructors

Properties

level origin path

Accessors

[toStringTag] name

Methods

Constructors

constructor

new ValidationError(
    message: string,
    origin?: string,
    path?: readonly string[],
): ValidationError
Parameters
- message: string
  The validation error message.
- origin: string = ErrorOrigin.API
  The error origin, typically API (default) or SERVICE_EXTERNAL
- path: readonly string[] = []
  The property path to the invalid field.
Returns ValidationError
Overrides ReportableError.constructor
- Defined in error/ValidationError.ts:22

Properties

`Readonly`level

level: ErrorLevel = ErrorLevel.FATAL

`Readonly`origin

origin: string = ErrorOrigin.INTERNAL

`Readonly`path

path: readonly string[] = []

The property path to the invalid field.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides ReportableError.[toStringTag]
- Defined in error/ValidationError.ts:13

name

get name(): string
Returns string
Inherited from ReportableError.name
- Defined in error/ReportableError.ts:42

Methods

toJSON

toJSON(): AnyRecord
All ReportableError instances must be serializable.

Returns AnyRecord
Overrides ReportableError.toJSON
- Defined in error/ValidationError.ts:31