Class KindError

An error to describe detailed states and relationships.

This error type supports error taxonomies and attachment of metadata, as well as causal relationships between itself and another source error. More specific variations can be built off this to provide a payload for logging setups like Sentry or winston.

Hierarchy

Constructors

constructor

Properties

cause kind message metadata name originalMessage originalStack stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Creates an instance of KindError.

    Parameters

    • message: string

      The error message.

    • Optional kind: string = Errors.Unknown

      The kind of error. This will be combined with prefix to form the name of the error, i.e. PrefixKindError. Defaults to Errors.Unknown.

    • Optional options: Options = ...

      Options for constructing the error.

    Returns KindError

    Memberof

    KindError

Properties

Readonly cause

cause: undefined | null | Error

Readonly kind

kind: string

message

message: string

Readonly metadata

metadata: undefined | null | Readonly<Metadata>

name

name: string

Readonly originalMessage

originalMessage: string

Readonly originalStack

originalStack: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc