Class ValidationError

Base class for validation errors and used when Data validation fails. Please check the provided data. We encode this as StatusResponseError that returns a ConstrainError which is suitable for most "invalid/out-of-bounds values" cases. If you can use any of the more detailed errors derived from this class please do so!

Hierarchy (view full)

Constructors

constructor

Properties

clusterCode? code fieldName? defaultFormatterFactory formatterFor

Methods

[inspect] format accept is reject

Constructors

constructor

Properties

Optional ReadonlyclusterCode

clusterCode?: number

Readonlycode

code: Status

OptionalfieldName

fieldName?: string

StaticdefaultFormatterFactory

defaultFormatterFactory: (() => ((value: unknown, indents?: number) => string))

The fallback formatter factory. This produces a limited plaintext formatter.

StaticformatterFor

formatterFor: ((formatName: string) => ((value: unknown, indents?: number) => unknown))

The error formatter factory. The default formatter is replaced by Matter.js in ./Format.ts.

Methods

[inspect]

  • [inspect](depth, inspectionOptions?): unknown

  • Node.js-style object inspection.

    Node's default inspection only prevents two levels of depth which may hide critical information. It's also considerably more verbose than native matter.js formatting. We therefore offer this custom implementation.

    Note that this conforms to Node's API but is not dependent on Node.

    Parameters

    • depth: number
    • OptionalinspectionOptions: {
          colors?: boolean;
      }
      • Optionalcolors?: boolean

    Returns unknown

format

  • format(format?, indents?): string

  • Convert the error to formatted text.

    Matter encodes errors with modern JS features including Error#cause and AggregateError#errors subfields. You can use this function to ensure all error details are presented regardless of environment.

    Parameters

    • Optionalformat: "plain" | "ansi" | "html"
    • Optionalindents: number

    Returns string

Staticaccept

  • accept<T>(this, error): asserts error is T

  • Rethrow an error unless it is an instance of this class.

    Type Parameters

    Parameters

    • this: (new (...args: any[]) => T)
        • new (...args): T

        • Parameters

          • Rest...args: any[]

          Returns T

    • error: unknown

    Returns asserts error is T

Staticis

Staticreject

  • reject(error): void

  • Rethrow an error if it is an instance of this class.

    Parameters

    • error: unknown

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods