Class SocketClient

Hierarchy

SocketClient

Index

Constructors

constructor

Properties

_socket

Methods

Constructors

constructor

new SocketClient(endpoint: string, options?: any): SocketClient

- Defined in src/Api/socket.ts:301
Parameters
- endpoint: string
- Optional options: any
Returns SocketClient

Properties

Private _socket

_socket: typeof Socket

Methods

close

close(): void

- Defined in src/Api/socket.ts:360
Returns void

off

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

- Defined in src/Api/socket.ts:315
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 src/Api/socket.ts:350
Parameters
- fn: Function
Returns this

on

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

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

onConnect

onConnect(fn: Function): this

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

onError

onError(fn: Function): this

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

subscribe

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

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

unsubscribe

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

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

Generated using TypeDoc