Package version:

Interface WebPubSubClientOptions

The client options

Hierarchy

  • WebPubSubClientOptions

Properties

autoReconnect? autoRejoinGroups? messageRetryOptions? protocol? reconnectRetryOptions?

Properties

Optional autoReconnect

autoReconnect?: boolean

Whether to auto reconnect after connection is dropped and not recoverable

Optional autoRejoinGroups

autoRejoinGroups?: boolean

Whether to enable restoring group after reconnecting

Optional messageRetryOptions

messageRetryOptions?: WebPubSubRetryOptions

The retry options for operations like joining group and sending messages

Optional protocol

protocol?: WebPubSubClientProtocol

The subprotocol

Optional reconnectRetryOptions

reconnectRetryOptions?: WebPubSubRetryOptions

The retry options for reconnection. Only available when autoReconnect is true.

Settings

Member Visibility

Theme

Generated using TypeDoc