MCPcopy
hub / github.com/socketio/socket.io / leave

Method leave

packages/socket.io/lib/socket.ts:485–489  ·  view source on GitHub ↗

* Leaves a room. * * @example * io.on("connection", (socket) => { * // leave a single room * socket.leave("room1"); * * // leave multiple rooms * socket.leave("room1").leave("room2"); * }); * * @param {String} room * @return a Promise or nothing, depending

(room: string)

Source from the content-addressed store, hash-verified

483 * @return a Promise or nothing, depending on the adapter
484 */
485 public leave(room: string): Promise<void> | void {
486 debug("leave room %s", room);
487
488 return this.adapter.del(this.id, room);
489 }
490
491 /**
492 * Leave all rooms.

Callers 3

delSocketsMethod · 0.45
messaging-many.tsFile · 0.45
uws.tsFile · 0.45

Calls 2

debugFunction · 0.85
delMethod · 0.80

Tested by

no test coverage detected