Class WebSocketClient

Websocket client

Hierarchy

WebSocketClient

Index

Constructors

Properties

#alreadyConnected #connection #eventTarget onError socketURLGetter

Methods

#isSocketURLGetterRejection #setupConnection #socketEventHandler _errorHandler connect disconnect off on reconnect send

Constructors

constructor

new WebSocketClient(onError, socketURLGetter): WebSocketClient
Parameters
- onError: undefined | ((error) => void)
- socketURLGetter: (() => Promise<string>)
  - - (): Promise<string>
    - Returns Promise<string>
Returns WebSocketClient

Properties

`Private` #alreadyConnected

#alreadyConnected: boolean = false

`Private` #connection

#connection: null | WebSocketClient = null

`Private` #eventTarget

#eventTarget: WebSocketClient

`Private` onError

onError: undefined | ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: Error
  Returns void

`Private` socketURLGetter

socketURLGetter: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Returns Promise<string>

Methods

`Private` #isSocketURLGetterRejection

#isSocketURLGetterRejection(error): boolean
True only when error is one of the specific types the caller-supplied socketURLGetter is known to reject with (ChatSdk's #createSocketUrl throws these on a failed authorization grant) — not a generic instanceof Error check, so an unrelated library change that starts populating ErrorEvent.error can't silently disable real error reporting above.
Parameters
- error: unknown
Returns boolean

`Private` #setupConnection

#setupConnection(): void
Returns void

`Private` #socketEventHandler

#socketEventHandler(event): void
Parameters
- event: CustomEvent<Event | ErrorEvent | CloseEvent>
Returns void

`Private` _errorHandler

_errorHandler(event): void
Handle error from event listeners with onError callback or throw error
Parameters
- event: CustomEvent<Event | ErrorEvent | CloseEvent>
Returns void

connect

connect(): Promise<void>
Connect websocket

Returns Promise<void>

disconnect

disconnect(): void
Disconnect websocket

Returns void

off

off(eventType, handlerCallback): void
Unregister event handler to websocket event
Parameters
- eventType: WebSocketClientEvent
  
  websocket event
- handlerCallback: ((event) => void)
  
  event handler
  - - (event): void
    - Parameters
      
      event: CustomEvent<any>
      
      Returns void
Returns void

on

on(eventType, handlerCallback): void
Register event handler to websocket event
Parameters
- eventType: WebSocketClientEvent
  
  websocket event
- handlerCallback: ((event) => void)
  
  event handler
  - - (event): void
    - Parameters
      
      event: ChatCustomEvent<ChatEventData>
      
      Returns void
Returns void

reconnect

reconnect(): void
Reconnect websocket

Returns void

send

send(data): void
Send data to active connection
Parameters
- data: unknown
  
  data to send
Returns void

Generated using TypeDoc