Class Error

Hierarchy

Constructors

constructor

Properties

message name stack? Failed Invalid Missing Unimplemented Unsupported prepareStackTrace? stackTraceLimit

Methods

captureStackTrace define

Constructors

constructor

  • Parameters

    • Optional message: string

    Returns Base.Error

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Static Failed

Failed: typeof FadromaError_Failed

Thrown when an operation fails.

Static Invalid

Invalid: typeof FadromaError_Invalid

Thrown when an invalid value or operation is at hand.

Static Missing

Missing: typeof FadromaError_Missing

Thrown when a required parameter is missing.

Static Unimplemented

Unimplemented: typeof OopsError = ...

Thrown when the control flow reaches unimplemented areas.

Static Unsupported

Unsupported: typeof FadromaError_Unsupported

Thrown when unsupported functionality is requested.

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

Static define

  • Define an error subclass.

    Type Parameters

    • T extends unknown[]

    Parameters

    • name: string

      Name of error class. Prepended to parent.

    • getMessage: string | ((...args) => string) = ...

      How to generate the error message from the arguments passed to the constructor.

    • Optional construct: ((self, ...args) => any)

      Whether there are any further construction steps such as assigning properties.

        • (self, ...args): any

        • Whether there are any further construction steps such as assigning properties.

          Parameters

          • self: Error
          • Rest ...args: T

          Returns any

    Returns typeof OopsError

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc