Class SocketClient

Hierarchy

SocketClient

Index

Constructors

constructor

Properties

_socket

Methods

Constructors

constructor

new SocketClient(endpoint: string): SocketClient

- Defined in Api/socket.ts:50
Parameters
- endpoint: string
Returns SocketClient

Properties

Private _socket

_socket: typeof Socket

Methods

close

close(): void

- Defined in Api/socket.ts:92
Returns void

off

off<TChannel>(channel: TChannel, fn: (response: ResponseByChannel<TChannel>) => unknown): this

- Defined in Api/socket.ts:61
Type parameters
- TChannel: SocketChannels
Parameters
- channel: TChannel
- fn: (response: ResponseByChannel<TChannel>) => unknown
  - - (response: ResponseByChannel<TChannel>): unknown
    - Parameters
      - response: ResponseByChannel<TChannel>
      Returns unknown
Returns this

offError

offError(fn: Function): this

- Defined in Api/socket.ts:87
Parameters
- fn: Function
Returns this

on

on<TChannel>(channel: TChannel, fn: (response: ResponseByChannel<TChannel>) => unknown): this

- Defined in Api/socket.ts:56
Type parameters
- TChannel: SocketChannels
Parameters
- channel: TChannel
- fn: (response: ResponseByChannel<TChannel>) => unknown
  - - (response: ResponseByChannel<TChannel>): unknown
    - Parameters
      - response: ResponseByChannel<TChannel>
      Returns unknown
Returns this

onError

onError(fn: Function): this

- Defined in Api/socket.ts:82
Parameters
- fn: Function
Returns this

subscribe

subscribe<TChannel>(channel: TChannel, params: ParamsByChannel<TChannel>): this

- Defined in Api/socket.ts:66
Type parameters
- TChannel: SocketChannels
Parameters
- channel: TChannel
- params: ParamsByChannel<TChannel>
Returns this

unsubscribe

unsubscribe<TChannel>(channel: TChannel, params: ParamsByChannel<TChannel>): this

- Defined in Api/socket.ts:74
Type parameters
- TChannel: SocketChannels
Parameters
- channel: TChannel
- params: ParamsByChannel<TChannel>
Returns this

Generated using TypeDoc