Class WebSocketClient

Websocket client

Hierarchy

WebSocketClient

Index

Constructors

Properties

_connection brandId channelId customerId onError? options?

Methods

_errorHandler connect disconnect off on reconnect send

Constructors

constructor

new WebSocketClient(brandId, channelId, customerId, options?, onError?): WebSocketClient
Parameters
- brandId: BrandId
- channelId: ChannelId
- customerId: CustomerIdentityIdOnExternalPlatform
- Optional options: WebSocketClientOptions
- Optional onError: ((error) => void)
  - - (error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns WebSocketClient

Properties

`Private` _connection

_connection: null | WebSocketClient = null

`Private` brandId

brandId: BrandId

`Private` channelId

channelId: ChannelId

`Private` customerId

customerId: CustomerIdentityIdOnExternalPlatform

`Private` `Optional` onError

onError?: ((error) => void)

Type declaration

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

`Private` `Optional` options

options?: WebSocketClientOptions

Methods

`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(): void
Connect websocket

Returns 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: CustomEvent<any>
      
      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