Class ErrorPolykeyCLI<T>

Root error for Polykey CLI. Application errors may need to be serialised over program boundaries. For example presenting errors on the terminal, or sending errors over the network.

Type Parameters

  • T

Hierarchy

Constructors

constructor

Properties

cause data exitCode message name stack? timestamp description prepareStackTrace? stackTraceLimit

Accessors

description

Methods

toJSON captureStackTrace fromJSON

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • Optional message: string
    • Optional options: {
          cause?: T;
          data?: POJO;
          timestamp?: Date;
      }
      • Optional cause?: T
      • Optional data?: POJO
      • Optional timestamp?: Date

    Returns ErrorPolykeyCLI<T>

Properties

cause

cause: T

Causation of the exception Can be used to know what caused this exception

data

data: POJO

Arbitrary data

exitCode

exitCode: number = sysexits.GENERAL

message

message: string

name

name: string

Optional stack

stack?: string

timestamp

timestamp: Date

Timestamp when exception was constructed in milliseconds Guaranteed to be weakly monotonic

Static description

description: string = 'Polykey CLI error'

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • Returns any

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • Type Parameters

    • T extends Class<any>

    Parameters

    • this: T
    • json: any

    Returns InstanceType<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc