Class WebSocketClient<WSCommand>

Type Parameters

WSCommand

Hierarchy

EventTarget<WebsocketEventMap<WSCommand>>
- WebSocketClient

Index

Constructors

Properties

_listeners off on

Accessors

Methods

_dispatchEvent addEventListener clearSessionKey connect once processCommand removeAllEventListeners removeEventListener setSessionKey

Constructors

constructor

new WebSocketClient<WSCommand>(_ctx: WebsocketClientContext<WSCommand>): WebSocketClient<WSCommand>
Type Parameters
- WSCommand
Parameters
- _ctx: WebsocketClientContext<WSCommand>
Returns WebSocketClient<WSCommand>

Overrides EventTarget.constructor

Properties

`Protected` _listeners

_listeners: { command?: EventListener<{ args: [WSCommand] }>[]; error?: EventListener<{ args: [Error] }>[] } = {}

Type declaration

Optional command?: EventListener<{ args: [WSCommand] }>[]
Optional error?: EventListener<{ args: [Error] }>[]

off

off: (<K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>) => void) = ...

Type declaration

- <K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>): void
- Type Parameters
  - K extends keyof WebsocketEventMap<WSCommand>
  Parameters
  - type: K
  - callback: EventListener<WebsocketEventMap<WSCommand>[K]>
  Returns void

on

on: (<K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>) => (() => void)) = ...

Type declaration

- <K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>): (() => void)
- Type Parameters
  - K extends keyof WebsocketEventMap<WSCommand>
  Parameters
  - type: K
  - callback: EventListener<WebsocketEventMap<WSCommand>[K]>
  Returns (() => void)
  - - (): void
    - Returns void

Accessors

isConnected

get isConnected(): boolean
Returns boolean

Methods

`Protected` _dispatchEvent

_dispatchEvent<K>(type: K, ...args: ArgsType<WebsocketEventMap<WSCommand>[K]>): void
Type Parameters
- K extends keyof WebsocketEventMap<WSCommand>
Parameters
- type: K
- Rest ...args: ArgsType<WebsocketEventMap<WSCommand>[K]>
Returns void

Inherited from EventTarget._dispatchEvent

addEventListener

addEventListener<K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>): (() => void)
Type Parameters
- K extends keyof WebsocketEventMap<WSCommand>
Parameters
- type: K
- callback: EventListener<WebsocketEventMap<WSCommand>[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.addEventListener

clearSessionKey

clearSessionKey(): void
Returns void

connect

connect(): Promise<unknown>
Returns Promise<unknown>

once

once<K>(type: K, givenCb: EventListener<WebsocketEventMap<WSCommand>[K]>): (() => void)
Type Parameters
- K extends keyof WebsocketEventMap<WSCommand>
Parameters
- type: K
- givenCb: EventListener<WebsocketEventMap<WSCommand>[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.once

processCommand

processCommand(command: WSCommand): void
Parameters
- command: WSCommand
Returns void

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

removeEventListener<K>(type: K, callback: EventListener<WebsocketEventMap<WSCommand>[K]>): void
Type Parameters
- K extends keyof WebsocketEventMap<WSCommand>
Parameters
- type: K
- callback: EventListener<WebsocketEventMap<WSCommand>[K]>
Returns void

Inherited from EventTarget.removeEventListener

setSessionKey

setSessionKey(sessionKey: string): void
Parameters
- sessionKey: string
Returns void

Generated using TypeDoc