Class SocketIOWebsocketConnection

constructor

• new SocketIOWebsocketConnection(
      socket: Socket,
      userId: undefined | string,
  ): SocketIOWebsocketConnection

  Parameters

  • socket: Socket
  • userId: undefined | string

  Returns SocketIOWebsocketConnection

Readonlyid

Readonlyrecovered

userId

offset

• get offset(): number

  The current offset of the connection. Is used to sync the state of the server with the client after a reconnect.

  Returns number
• set offset(value: number): void

  The current offset of the connection. Is used to sync the state of the server with the client after a reconnect.

  Parameters

  • value: number

  Returns void

disconnect

• disconnect(close: boolean): void

  Disconnects the socket.

  Parameters

  • close: boolean

    Whether or not to close the underlying connection.

  Returns void

emit

• emit(event: LooseWebsocketEvent, data: WebsocketMessage): void

  Emits an event to the socket.

  Parameters

  • event: LooseWebsocketEvent

    The event to emit.
  • data: WebsocketMessage

    The data to emit.

  Returns void

emitWithAck

• emitWithAck<R>(
      event: LooseWebsocketEvent,
      data: WebsocketMessage,
      timeout: number,
  ): Promise<R>

  Emits an event to the socket and expects a return.

  Type Parameters

  • R

  Parameters

  • event: LooseWebsocketEvent

    The event to emit.
  • data: WebsocketMessage

    The data to emit.
  • timeout: number

    The timeout after which an error should be thrown.

  Returns Promise<R>

  The response from the connection.

join

• join(channels: string | string[]): Promise<void>

  Joins the given channel or channels.

  Parameters

  • channels: string | string[]

    The channel or channels to join.

  Returns Promise<void>

leave

• leave(channels: string | string[]): Promise<void>

  Leaves the given channel or channels.

  Parameters

  • channels: string | string[]

    The channel or channels to join.

  Returns Promise<void>

onAny

• onAny(listener: (ev: string, ...args: unknown[]) => void | Promise<void>): void

  Adds a listener that will be fired when any event is received. The event name is passed as the first argument to the callback.

  Parameters

  • listener: (ev: string, ...args: unknown[]) => void | Promise<void>

    The listener to register.

  Returns void

onDisconnect

• onDisconnect(listener: () => void | Promise<void>): void

  Registers an on disconnect event listener.

  Parameters

  • listener: () => void | Promise<void>

    The listener to register.

  Returns void