Skip to main content
Version: Next

Class: WebSocketNotConnectedError

Thrown when an operation is attempted on a WebSocket that is not connected.

Hierarchy

Constructors

constructor

new WebSocketNotConnectedError(message): WebSocketNotConnectedError

Parameters

NameType
messagestring

Returns

WebSocketNotConnectedError

Overrides

LibraryError.constructor

Defined in

src/utils/errors/index.ts:96

Properties

stackTraceLimit

Static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

LibraryError.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:162


name

name: string

The name of the error, always 'WebSocketNotConnectedError'.

Inherited from

LibraryError.name

Defined in

src/utils/errors/index.ts:21


message

message: string

Inherited from

LibraryError.message

Defined in

www/node_modules/typescript/lib/lib.es5.d.ts:1055


stack

Optional stack: string

Inherited from

LibraryError.stack

Defined in

www/node_modules/typescript/lib/lib.es5.d.ts:1056


cause

Optional cause: unknown

Inherited from

LibraryError.cause

Defined in

www/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
b();
}

function b() {
c();
}

function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;

// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}

a();

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

LibraryError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:146


prepareStackTrace

prepareStackTrace(err, stackTraces): any

Parameters

NameType
errError
stackTracesCallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

LibraryError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:150