Skip to content

fix: allow socketsJoin/socketsLeave/disconnectSockets to be awaited #5581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Ankit-Silwal wants to merge 1 commit into from
+20 −11
Closed

fix: allow socketsJoin/socketsLeave/disconnectSockets to be awaited #5581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions packages/socket.io-adapter/lib/in-memory-adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,10 @@ export class Adapter extends EventEmitter {
* @param opts - the filters to apply
* @param rooms - the rooms to join
*/
public addSockets(opts: BroadcastOptions, rooms: Room[]): void {
public addSockets(
opts: BroadcastOptions,
rooms: Room[],
): void | Promise<void> {
this.apply(opts, (socket) => {
socket.join(rooms);
});
Expand All @@ -312,7 +315,10 @@ export class Adapter extends EventEmitter {
* @param opts - the filters to apply
* @param rooms - the rooms to leave
*/
public delSockets(opts: BroadcastOptions, rooms: Room[]): void {
public delSockets(
opts: BroadcastOptions,
rooms: Room[],
): void | Promise<void> {
this.apply(opts, (socket) => {
rooms.forEach((room) => socket.leave(room));
});
Expand All @@ -324,7 +330,10 @@ export class Adapter extends EventEmitter {
* @param opts - the filters to apply
* @param close - whether to close the underlying connection
*/
public disconnectSockets(opts: BroadcastOptions, close: boolean): void {
public disconnectSockets(
opts: BroadcastOptions,
close: boolean,
): void | Promise<void> {
this.apply(opts, (socket) => {
socket.disconnect(close);
});
Expand Down
16 changes: 8 additions & 8 deletions packages/socket.io/lib/broadcast-operator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,8 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
*
* @param room - a room, or an array of rooms
*/
public socketsJoin(room: Room | Room[]): void {
this.adapter.addSockets(
public socketsJoin(room: Room | Room[]): void | Promise<void> {
return this.adapter.addSockets(
{
rooms: this.rooms,
except: this.exceptRooms,
Expand All @@ -438,8 +438,8 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
*
* @param room - a room, or an array of rooms
*/
public socketsLeave(room: Room | Room[]): void {
this.adapter.delSockets(
public socketsLeave(room: Room | Room[]): void | Promise<void> {
return this.adapter.delSockets(
{
rooms: this.rooms,
except: this.exceptRooms,
Expand All @@ -463,8 +463,8 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
*
* @param close - whether to close the underlying connection
*/
public disconnectSockets(close: boolean = false): void {
this.adapter.disconnectSockets(
public disconnectSockets(close: boolean = false): void | Promise<void> {
return this.adapter.disconnectSockets(
{
rooms: this.rooms,
except: this.exceptRooms,
Expand Down Expand Up @@ -554,7 +554,7 @@ export class RemoteSocket<EmitEvents extends EventsMap, SocketData>
*
* @param {String|Array} room - room or array of rooms
*/
public join(room: Room | Room[]): void {
public join(room: Room | Room[]): void | Promise<void> {
return this.operator.socketsJoin(room);
}

Expand All @@ -563,7 +563,7 @@ export class RemoteSocket<EmitEvents extends EventsMap, SocketData>
*
* @param {String} room
*/
public leave(room: Room): void {
public leave(room: Room): void | Promise<void> {
return this.operator.socketsLeave(room);
}

Expand Down