Class Socket

constructor

• new Socket(url: string, config?: SocketConfig): Socket

  Parameters

  • url: string
  • config: SocketConfig = {}

  Returns Socket

ReadonlytimeoutMs

isConnected

• get isConnected(): boolean

  Returns boolean

channel

• channel(topic: string, params?: Record<string, unknown>): Channel

  Parameters

  • topic: string
  • params: Record<string, unknown> = {}

  Returns Channel

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

makeRef

• makeRef(): string

  Returns string

onEvent

• onEvent(listener: (event: SocketEvent) => void): () => void

  Parameters

  • listener: (event: SocketEvent) => void

  Returns () => void

removeChannel

• removeChannel(topic: string): void

  Parameters

  • topic: string

  Returns void

send

• send(
      joinRef: string | null,
      ref: string | null,
      topic: string,
      event: string,
      payload: unknown,
  ): void

  Parameters

  • joinRef: string | null
  • ref: string | null
  • topic: string
  • event: string
  • payload: unknown

  Returns void