docs: add deprecation notice for the allSockets() method

socketio · Oct 13, 2022 · e6f6b90 · e6f6b90
1 parent 596eb88
commit e6f6b90
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/lib/index.ts b/lib/index.ts
@@ -746,6 +746,9 @@ export class Server<
   /**
    * Gets a list of socket ids.
    *
+   * @deprecated this method will be removed in the next major release, please use {@link Server#serverSideEmit} or
+   * {@link Server#fetchSockets} instead.
+   *
    * @public
    */
   public allSockets(): Promise<Set<SocketId>> {

diff --git a/lib/namespace.ts b/lib/namespace.ts
@@ -341,7 +341,9 @@ export class Namespace<
   /**
    * Gets a list of clients.
    *
-   * @return self
+   * @deprecated this method will be removed in the next major release, please use {@link Namespace#serverSideEmit} or
+   * {@link Namespace#fetchSockets} instead.
+   *
    * @public
    */
   public allSockets(): Promise<Set<SocketId>> {