Class WebSocketDriver

WebSocket-based signaling driver with auto-reconnection and ping/pong support. It maintains a map of namespaces to sets of handlers, and automatically re-subscribes to namespaces after reconnection. It also queues messages when the socket is not opened, and flushes them upon connection.

Example

const driver = new WebSocketDriver({ url: 'wss://localhost:8443/ws' });

Hierarchy

Map
- WebSocketDriver

Implements

SignalingDriver

Index

Constructors

constructor

new WebSocketDriver(
    options?: {
        pingInterval?: number;
        pingTimeout?: number;
        protocols?: string | string[];
        queueLimit?: number;
        randomizationFactor?: number;
        reconnection?: boolean;
        reconnectionAttempts?: number;
        reconnectionDelay?: number;
        reconnectionDelayMax?: number;
        url?: string;
    },
): WebSocketDriver
Creates a new WebSocketDriver instance with the specified options.
Parameters
- Optionaloptions: {
      pingInterval?: number;
      pingTimeout?: number;
      protocols?: string | string[];
      queueLimit?: number;
      randomizationFactor?: number;
      reconnection?: boolean;
      reconnectionAttempts?: number;
      reconnectionDelay?: number;
      reconnectionDelayMax?: number;
      url?: string;
  }
  Configuration options for the driver.
  - OptionalpingInterval?: number
    Interval for sending ping messages in ms (default: 30000).
  - OptionalpingTimeout?: number
    Timeout for receiving pong responses in ms (default: 10000).
  - Optionalprotocols?: string | string[]
    Optional subprotocols for the WebSocket connection.
  - OptionalqueueLimit?: number
    Maximum number of queued messages when socket is not opened (default: 100).
  - OptionalrandomizationFactor?: number
    Randomization factor for reconnection delay (default: 0.5).
  - Optionalreconnection?: boolean
    Whether to enable auto-reconnection (default: true).
  - OptionalreconnectionAttempts?: number
    Maximum number of reconnection attempts (default: Infinity).
  - OptionalreconnectionDelay?: number
    Initial delay for reconnection attempts in ms (default: 5000).
  - OptionalreconnectionDelayMax?: number
    Maximum delay for reconnection attempts in ms (default: 60000).
  - Optionalurl?: string
    The WebSocket server URL (default: '/ws').
Returns WebSocketDriver
Overrides Map.constructor
- Defined in src/drivers/websocket.ts:54

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

opened

get opened(): boolean
Indicates whether the WebSocket connection is currently open.

Returns boolean
- Defined in src/drivers/websocket.ts:35

Methods

[iterator]

"[iterator]"(): MapIterator<[any, any]>
Returns an iterable of entries in the map.

Returns MapIterator<[any, any]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

close

close(): void
Closes the WebSocket connection and clears all handlers and queued messages.

Returns void
- Defined in src/drivers/websocket.ts:192

delete

delete(key: any): boolean
Parameters
- key: any
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

emit

emit(namespace: string[], message: any): void
Publish a signaling message to a namespace.
Parameters
- namespace: string[]
  Target namespace segments.
- message: any
Returns void
Implementation of SignalingDriver.emit
- Defined in src/drivers/websocket.ts:229

entries

entries(): MapIterator<[any, any]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[any, any]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(
callbackfn: (value: any, key: any, map: Map<any, any>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: any, key: any, map: Map<any, any>) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: any): any
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: any
Returns any
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key: any): boolean
Parameters
- key: any
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): MapIterator<any>
Returns an iterable of keys in the map

Returns MapIterator<any>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

off

off(namespace: string[], handler: (data: any) => void): void
Unsubscribe a previously registered namespace handler.
Parameters
- namespace: string[]
  Namespace segments used for message routing.
- handler: (data: any) => void
  Handler reference originally passed to on.
Returns void
Implementation of SignalingDriver.off
- Defined in src/drivers/websocket.ts:214

on

on(namespace: string[], handler: (data: any) => void): void
Subscribe to signaling messages in a namespace.
Parameters
- namespace: string[]
  Namespace segments used for message routing.
- handler: (data: any) => void
  Callback invoked with message payload.
Returns void
Implementation of SignalingDriver.on
- Defined in src/drivers/websocket.ts:200

open

open(): void
Opens a WebSocket connection to the server.

Returns void
- Defined in src/drivers/websocket.ts:96

set

set(key: any, value: any): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: any
- value: any
Returns this
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

values

values(): MapIterator<any>
Returns an iterable of values in the map

Returns MapIterator<any>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class WebSocketDriver

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalpingInterval?: number

OptionalpingTimeout?: number

Optionalprotocols?: string | string[]

OptionalqueueLimit?: number

OptionalrandomizationFactor?: number

Optionalreconnection?: boolean

OptionalreconnectionAttempts?: number

OptionalreconnectionDelay?: number

OptionalreconnectionDelayMax?: number

Optionalurl?: string

Returns WebSocketDriver

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Accessors

opened

Returns boolean

Methods

[iterator]

Returns MapIterator<[any, any]>

clear

Returns void

close

Returns void

delete

Parameters

Returns boolean

emit

Parameters

Returns void

entries

Returns MapIterator<[any, any]>

forEach

Parameters

Returns void

get

Parameters

Returns any

has

Parameters

Returns boolean

keys

Returns MapIterator<any>

off

Parameters

Returns void

on

Parameters

Returns void

open

Returns void

set

Parameters

Returns this

values

Returns MapIterator<any>

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

Settings

On This Page

`Optional`pingInterval?: number

`Optional`pingTimeout?: number

`Optional`protocols?: string | string[]

`Optional`queueLimit?: number

`Optional`randomizationFactor?: number

`Optional`reconnection?: boolean

`Optional`reconnectionAttempts?: number

`Optional`reconnectionDelay?: number

`Optional`reconnectionDelayMax?: number

`Optional`url?: string

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`groupBy