Interface WebsocketOptions

Options that can be passed to the Websocket constructor.

interface WebsocketOptions {
    buffer?: WebsocketBuffer<string | Blob | BufferSource>;
    listeners?: Partial<WebsocketEventListeners>;
    retry?: WebsocketConnectionRetryOptions;
}

Index

Properties

buffer? listeners? retry?

Properties

`Optional` `Readonly`buffer

buffer?: WebsocketBuffer<string | Blob | BufferSource>

The Buffer to use.

`Optional` `Readonly`listeners

listeners?: Partial<WebsocketEventListeners>

The initial listeners to add to the websocket. Event-types without listeners can be omitted.

`Optional` `Readonly`retry

retry?: WebsocketConnectionRetryOptions

The options for the connection-retry-strategy.