Class ErrorSerializer<ErrorType>

The ErrorSerializer class is used to serialize errors.

Example:

[[include:error-serializer.example.ts]]

Type Parameters

Constructors

constructor

Properties

options defaultOptions

Methods

serialize

Constructors

constructor

Properties

Private options

options: Readonly<ErrorSerializerOptions<ErrorType>>

The set of options for the serializer.

Static defaultOptions

defaultOptions: {
    attributes: {
        code: string;
        detail: string;
        id: string;
        source: {
            parameter: undefined;
            pointer: string;
        };
        status: string;
        title: string;
    };
    linkers: {};
    metaizers: {};
    version: string;
} = ...

Default options. Can be edited to change default options globally.

Type declaration

  • attributes: {
        code: string;
        detail: string;
        id: string;
        source: {
            parameter: undefined;
            pointer: string;
        };
        status: string;
        title: string;
    }
    • code: string
    • detail: string
    • id: string
    • source: {
          parameter: undefined;
          pointer: string;
      }
      • parameter: undefined
      • pointer: string
    • status: string
    • title: string
  • linkers: {}
    • metaizers: {}
      • version: string

      Methods

      serialize

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc