Class Websocket

A websocket wrapper that can be configured to reconnect automatically and buffer messages when the websocket is not connected.

Hierarchy

Websocket

Constructors

constructor

new Websocket(url, protocols?, options?): Websocket
Creates a new websocket.
Parameters
- url: string
  
  to connect to.
- Optional protocols: string | string[]
  
  optional protocols to use.
- Optional options: WebsocketOptions
  
  optional options to use.
Returns Websocket
- Defined in websocket.ts:37

Properties

`Private` _closedByUser

_closedByUser: boolean = false

`Private` `Optional` _lastConnection

_lastConnection?: Date

`Private` _options

_options: WebsocketOptions & Required<Pick<WebsocketOptions, "retry" | "listeners">>

`Private` `Optional` `Readonly` _protocols

_protocols?: string | string[]

`Private` _underlyingWebsocket

_underlyingWebsocket: WebSocket

`Private` `Readonly` _url

_url: string

`Private` `Optional` retryTimeout

retryTimeout?: Timeout

Accessors

backoff

get backoff(): undefined | Backoff
Getter for the backoff.

Returns undefined | Backoff
the backoff, or undefined if none was provided.
- Defined in websocket.ts:116

binaryType

get binaryType(): BinaryType
Getter for the binaryType of the underlying websocket.

Returns BinaryType
the binaryType of the underlying websocket.

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/binaryType
- Defined in websocket.ts:184
set binaryType(value): void
Setter for the binaryType of the underlying websocket.
Parameters
- value: BinaryType
  
  to set, 'blob' or 'arraybuffer'.
Returns void
- Defined in websocket.ts:193

buffer

get buffer(): undefined | WebsocketBuffer<string | ArrayBufferLike | ArrayBufferView | Blob>
Getter for the buffer.

Returns undefined | WebsocketBuffer<string | ArrayBufferLike | ArrayBufferView | Blob>
the buffer, or undefined if none was provided.
- Defined in websocket.ts:89

bufferedAmount

get bufferedAmount(): number
Getter for the bufferedAmount of the underlying websocket.

Returns number
the bufferedAmount of the underlying websocket.

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/bufferedAmount
- Defined in websocket.ts:164

closedByUser

get closedByUser(): boolean
Whether the websocket was closed by the user. A websocket is closed by the user if the close().

Returns boolean
true if the websocket was closed by the user, false otherwise.
- Defined in websocket.ts:125

extensions

get extensions(): string
Getter for the extensions of the underlying websocket.

Returns string
the extensions of the underlying websocket.

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/extensions
- Defined in websocket.ts:174

instantReconnect

get instantReconnect(): undefined | boolean
Getter for the instantReconnect.

Returns undefined | boolean
the instantReconnect, or undefined if none was provided.
- Defined in websocket.ts:107

lastConnection

get lastConnection(): undefined | Date
Getter for the last 'open' event, e.g. the last time the websocket was connected.

Returns undefined | Date
the last 'open' event, or undefined if the websocket was never connected.
- Defined in websocket.ts:134

maxRetries

get maxRetries(): undefined | number
Getter for the maxRetries.

Returns undefined | number
the maxRetries, or undefined if none was provided (no limit).
- Defined in websocket.ts:98

protocols

get protocols(): undefined | string | string[]
Getter for the protocols.

Returns undefined | string | string[]
the protocols, or undefined if none were provided.
- Defined in websocket.ts:80

readyState

get readyState(): number
Getter for the readyState of the underlying websocket.

Returns number
the readyState of the underlying websocket.

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState
- Defined in websocket.ts:154

underlyingWebsocket

get underlyingWebsocket(): WebSocket
Getter for the underlying websocket. This can be used to access the browser's native websocket directly.

Returns WebSocket
the underlying websocket.

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
- Defined in websocket.ts:144

url

get url(): string
Getter for the url.

Returns string
the url.
- Defined in websocket.ts:71

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Adds an event listener for the given event-type.
Type Parameters
- K extends WebsocketEvent
Parameters
- type: K
  
  of the event to add the listener for.
- listener: WebsocketEventListener<K>
  
  to add.
- Optional options: WebsocketEventListenerOptions
  
  to use when adding the listener.
Returns void

See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
- Defined in websocket.ts:239

`Private` cancelScheduledConnectionRetry

cancelScheduledConnectionRetry(): void
Cancels the scheduled connection-retry, if there is one.

Returns void
- Defined in websocket.ts:485

`Private` clearWebsocket

clearWebsocket(): void
Removes all event listeners from the browser-native websocket and closes it.

Returns void
- Defined in websocket.ts:298

close

close(code?, reason?): void
Close the websocket. No connection-retry will be attempted after this.
Parameters
- Optional code: number
  
  optional close code.
- Optional reason: string
  
  optional close reason.
Returns void

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close
- Defined in websocket.ts:225

`Private` dispatchEvent

dispatchEvent<K>(type, event): void
Dispatch an event to all listeners of the given event-type.
Type Parameters
- K extends WebsocketEvent
Parameters
- type: K
  
  of the event to dispatch.
- event: WebsocketEventMap[K]
  
  to dispatch.
Returns void
- Defined in websocket.ts:352

`Private` handleCloseEvent

handleCloseEvent(event): void
Handles the 'close' event of the browser-native websocket.
Parameters
- event: CloseEvent
  
  to handle.
Returns void
- Defined in websocket.ts:336

`Private` handleErrorEvent

handleErrorEvent(event): void
Handles the 'error' event of the browser-native websocket.
Parameters
- event: Event
  
  to handle.
Returns void
- Defined in websocket.ts:329

`Private` handleEvent

handleEvent<K>(type, event): void
Handles the given event by dispatching it to all listeners of the given event-type.
Type Parameters
- K extends WebsocketEvent
Parameters
- type: K
  
  of the event to handle.
- event: WebsocketEventMap[K]
  
  to handle.
Returns void
- Defined in websocket.ts:381

`Private` handleMessageEvent

handleMessageEvent(event): void
Handles the 'message' event of the browser-native websocket.
Parameters
- event: MessageEvent<any>
  
  to handle.
Returns void
- Defined in websocket.ts:343

`Private` handleOpenEvent

handleOpenEvent(event): void
Handles the 'open' event of the browser-native websocket.
Parameters
- event: Event
  
  to handle.
Returns void
- Defined in websocket.ts:322

removeEventListener

removeEventListener<K>(type, listener, options?): void
Removes one or more event listener for the given event-type that match the given listener and options.
Type Parameters
- K extends WebsocketEvent
Parameters
- type: K
  
  of the event to remove the listener for.
- listener: WebsocketEventListener<K>
  
  to remove.
- Optional options: WebsocketEventListenerOptions
  
  that were used when the listener was added.
Returns void
- Defined in websocket.ts:254

`Private` scheduleConnectionRetryIfNeeded

scheduleConnectionRetryIfNeeded(): void
Schedules a connection-retry if there is a backoff defined and the websocket was not closed by the user.

Returns void
- Defined in websocket.ts:442

send

send(data): void
Sends data over the websocket.

If the websocket is not connected and a buffer was provided on creation, the data will be added to the buffer. If no buffer was provided or the websocket was closed by the user, the data will be dropped.
Parameters
- data: string | ArrayBufferLike | ArrayBufferView | Blob
  
  to send.
Returns void

See
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send
- Defined in websocket.ts:206

`Private` sendBufferedData

sendBufferedData(): void
Sends buffered data if there is a buffer defined.

Returns void
- Defined in websocket.ts:425

`Private` tryConnect

tryConnect(): WebSocket
Creates a new browser-native websocket and connects it to the given URL with the given protocols and adds all event listeners to the browser-native websocket.

Returns WebSocket
the created browser-native websocket which is also stored in the '_underlyingWebsocket' property.
- Defined in websocket.ts:273

Class Websocket

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

Optional protocols: string | string[]

Optional options: WebsocketOptions

Returns Websocket

Properties

Private _closedByUser

Private Optional _lastConnection

Private _options

Private Optional Readonly _protocols

Private _underlyingWebsocket

Private Readonly _url

Private Optional retryTimeout

Accessors

backoff

Returns undefined | Backoff

binaryType

Returns BinaryType

See

Parameters

value: BinaryType

Returns void

buffer

Returns undefined | WebsocketBuffer<string | ArrayBufferLike | ArrayBufferView | Blob>

bufferedAmount

Returns number

See

closedByUser

Returns boolean

extensions

Returns string

See

instantReconnect

Returns undefined | boolean

lastConnection

Returns undefined | Date

maxRetries

Returns undefined | number

protocols

Returns undefined | string | string[]

readyState

Returns number

See

underlyingWebsocket

Returns WebSocket

See

url

Returns string

Methods

addEventListener

Type Parameters

K extends WebsocketEvent

Parameters

type: K

listener: WebsocketEventListener<K>

Optional options: WebsocketEventListenerOptions

Returns void

See

Private cancelScheduledConnectionRetry

Returns void

Private clearWebsocket

Returns void

close

Parameters

Optional code: number

Optional reason: string

Returns void

See

Private dispatchEvent

Type Parameters

K extends WebsocketEvent

`Optional` protocols: string | string[]

`Optional` options: WebsocketOptions

`Private` _closedByUser

`Private` `Optional` _lastConnection

`Private` _options

`Private` `Optional` `Readonly` _protocols

`Private` _underlyingWebsocket

`Private` `Readonly` _url

`Private` `Optional` retryTimeout

`Optional` options: WebsocketEventListenerOptions

`Private` cancelScheduledConnectionRetry

`Private` clearWebsocket

`Optional` code: number

`Optional` reason: string

`Private` dispatchEvent

`Private` handleCloseEvent

`Private` handleErrorEvent

`Private` handleEvent

`Private` handleMessageEvent

`Private` handleOpenEvent

`Optional` options: WebsocketEventListenerOptions

`Private` scheduleConnectionRetryIfNeeded

`Private` sendBufferedData

`Private` tryConnect