Skip to content

Commit e6f6b90

Browse files
docs: add deprecation notice for the allSockets() method
1 parent 596eb88 commit e6f6b90

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

lib/index.ts

+3
Original file line numberDiff line numberDiff line change
@@ -746,6 +746,9 @@ export class Server<
746746
/**
747747
* Gets a list of socket ids.
748748
*
749+
* @deprecated this method will be removed in the next major release, please use {@link Server#serverSideEmit} or
750+
* {@link Server#fetchSockets} instead.
751+
*
749752
* @public
750753
*/
751754
public allSockets(): Promise<Set<SocketId>> {

lib/namespace.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,9 @@ export class Namespace<
341341
/**
342342
* Gets a list of clients.
343343
*
344-
* @return self
344+
* @deprecated this method will be removed in the next major release, please use {@link Namespace#serverSideEmit} or
345+
* {@link Namespace#fetchSockets} instead.
346+
*
345347
* @public
346348
*/
347349
public allSockets(): Promise<Set<SocketId>> {

0 commit comments

Comments
 (0)