Skip to main content

​
Methods

​
emit

Send event to client. 
socket.emit(event: string, data: any, ackCallback?: Function): void

​
on

Listen for client events. 
socket.on(event: string, handler: (data: any, ack?: Function) => void): void

​
join

Join a room. 
socket.join(room: string): Promise<void>

​
leave

Leave a room. 
socket.leave(room: string): Promise<void>

​
getRooms

Get all joined rooms. 
socket.getRooms(): Set<string>

​
broadcastToRoom

Send event to all clients in room. 
socket.broadcastToRoom(room: string, event: string, data: any): void

​
disconnect

Disconnect client. 
socket.disconnect(): void

​
Properties

  • id (string) - Unique session identifier
  • connected (boolean) - Connection status