Class ErrorWebSocketStreamLocalRead<T>

Type Parameters

  • T

Hierarchy

Constructors

constructor

Properties

cause data message name stack? timestamp description prepareStackTrace? stackTraceLimit

Accessors

description

Methods

toJSON captureStackTrace fromJSON

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • message: string = ''
    • options: {
          cause?: T;
          data: POJO & {
              code: number;
          };
          timestamp?: Date;
      }
      • Optional cause?: T
      • data: POJO & {
            code: number;
        }
      • Optional timestamp?: Date

    Returns ErrorWebSocketStreamLocalRead<T>

Properties

cause

cause: T

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

data

data: POJO & {
    code: number;
}

Arbitrary data

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 = 'WebSocket Stream locally closed readable side'

Static Optional prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • Encoding to JSON pojo When overriding this, you can use super.toJSON The replacer will:

    • delete undefined values in objects
    • replace undefined values for null in arrays

    Returns any

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • Runtime decoding of JSON POJO to exception instance When overriding this, you cannot use super.fromJSON You must write it fully, and use the same type-hacks to support polymorphic this in static methods https://github.com/microsoft/TypeScript/issues/5863

    Type Parameters

    • T extends Class<any>

    Parameters

    • this: T
    • json: any

    Returns InstanceType<T>

Settings

Member Visibility

Theme

Generated using TypeDoc