Class CommandRouter

Hierarchy

EventTarget<WebsocketEventMap<EventCommand>>
- CommandRouter

Index

Constructors

Properties

_listeners apiClient off on wsClient

Methods

_dispatchEvent addEventListener authenticate connectWs deauthenticate once removeAllEventListeners removeEventListener send sendWithRetry

Constructors

constructor

new CommandRouter(_ctx: Partial<ApplicationContext>): CommandRouter
Parameters
- _ctx: Partial<ApplicationContext>
Returns CommandRouter

Overrides EventTarget.constructor

Properties

`Protected` _listeners

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

Type declaration

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

apiClient

apiClient: APIClient

off

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

Type declaration

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

on

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

Type declaration

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

wsClient

wsClient: WebSocketClient<EventCommand>

Methods

`Protected` _dispatchEvent

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

Inherited from EventTarget._dispatchEvent

addEventListener

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

authenticate

authenticate(__namedParameters: AuthOption): Promise<void>
Parameters
- __namedParameters: AuthOption
Returns Promise<void>

connectWs

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

deauthenticate

deauthenticate(): void
Returns void

once

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

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

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

Inherited from EventTarget.removeEventListener

send

send(req: APICommand): Promise<any>
Parameters
- req: APICommand
Returns Promise<any>

sendWithRetry

sendWithRetry(req: APICommand, strategy?: RetryStrategy, meta?: { count: number; deferred: Deferred<any> }): Promise<any>
Parameters
- req: APICommand
- strategy: RetryStrategy = ...
- meta: { count: number; deferred: Deferred<any> } = ...
  - count: number
  - deferred: Deferred<any>
Returns Promise<any>

Generated using TypeDoc