Class Socket

constructor

• new Socket(api: Api, options?: SocketOptions): Socket

  Parameters

  • api: Api
  • options: SocketOptions = {}

  Returns Socket

open

Readonlyoptions

addListener

• addListener(fn: SocketListener, reconnect: () => void): Unsubscribe

  Add listener for all socket events

  Parameters

  • fn: SocketListener

    Callback function
  • reconnect: () => void

  Returns Unsubscribe

  Function to unsubscribe callback

close

• close(): void

  Close socket connection

  Returns void

connect

• connect(timeout?: number): void

  Connect socket client to socket server

  Parameters

  • timeout: number = 30

    Retry to connect every x seconds

  Returns void

send

• send(payload: any): void

  Send data to socket server

  Parameters

  • payload: any

    Data that will be serialized

  Returns void

sliceEvents

• sliceEvents(
      slice: string | number | string[] | number[],
      callback: SocketListener<SocketEventSlice>,
  ): Unsubscribe

  Run callback whenever the server notifies us of slice changes

  Parameters

  • slice: string | number | string[] | number[]

    Slice to subscribe to
  • callback: SocketListener<SocketEventSlice>

    Function to run on changes

  Returns Unsubscribe

  Run returned function to unsubscribe callback