WebSocketSessionError
Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:16
A session failure (TA-22): the session is over, or the dial failed.
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebSocketSessionError(message, options?): WebSocketSessionError;Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:26
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
message |
string |
options? |
{ cause?: unknown; close?: CloseInfo; } |
options.cause? |
unknown |
options.close? |
CloseInfo |
Returns
Section titled “Returns”WebSocketSessionError
Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”cause?: unknown;Defined in: typescript/lib/lib.es2022.error.d.ts:24
Inherited from
Section titled “Inherited from”Error.cause
closeCode?
Section titled “closeCode?”readonly closeCode?: number;Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:22
The peer’s application close code, when the peer closed the session (TA-24).
message
Section titled “message”message: string;Defined in: typescript/lib/lib.es5.d.ts:1075
Inherited from
Section titled “Inherited from”Error.message
readonly name: "WebSocketSessionError" = 'WebSocketSessionError';Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:18
Always 'WebSocketSessionError'; not part of the contract, which classifies by source.
Overrides
Section titled “Overrides”Error.name
reason?
Section titled “reason?”readonly reason?: string;Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:24
The peer’s close reason, when the peer closed the session (TA-24).
source
Section titled “source”readonly source: "session" = 'session';Defined in: relay-sdks/ts/packages/relay-websocket/src/errors.ts:20
Always 'session'.
stack?
Section titled “stack?”stack?: string;Defined in: typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.stack