Class MatterError

StaticformatterFor

[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

  • format: "plain" | "ansi" | "html" = "plain"
  • indents: number = 0

  Returns string

Staticaccept

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

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

  Type Parameters

  • T extends MatterError

  Parameters

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

      • Parameters

        • Rest...args: any[]

        Returns T

  • error: unknown

  Returns asserts error is T

StaticdefaultFormatterFactory

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

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

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

  • • (value, indents?): string

    • It's never reasonable to fail to present error information so we include this rudimentary fallback error formatter.

      Parameters

      • value: unknown
      • indents: number = 0

      Returns string

Staticreject

• reject(error): void

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

  Parameters

  • error: unknown

  Returns void