Class ErrorWebSocket<T>

Type Parameters

T

Hierarchy

AbstractError<T>
- ErrorWebSocket

Index

Constructors

Properties

cause data message name stack? timestamp description prepareStackTrace? stackTraceLimit

Accessors

Methods

toJSON captureStackTrace fromJSON

Constructors

constructor

new ErrorWebSocket<T>(message?: string, options?: {
    cause?: T;
    data?: POJO;
    timestamp?: Date;
}): ErrorWebSocket<T>
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 ErrorWebSocket<T>
Inherited from AbstractError<T>.constructor
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:34

Properties

cause

cause: T

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

data

data: POJO

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 error'

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

description

get description(): string
Returns string
Inherited from AbstractError.description
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:39

Methods

toJSON

toJSON(): any
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
Inherited from AbstractError.toJSON
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:47

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from AbstractError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` fromJSON

fromJSON<T>(this: T, json: any): InstanceType<T>
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>
Inherited from AbstractError.fromJSON
- Defined in node_modules/@matrixai/errors/dist/AbstractError.d.ts:19

Generated using TypeDoc