From e6f6b906db8209996b1adb564332cb443df38fc6 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Thu, 13 Oct 2022 15:02:23 +0200 Subject: [PATCH] docs: add deprecation notice for the allSockets() method --- lib/index.ts | 3 +++ lib/namespace.ts | 4 +++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/index.ts b/lib/index.ts index 29bf5e2ddb..291b1c6150 100644 --- 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> { diff --git a/lib/namespace.ts b/lib/namespace.ts index b769bf0f79..0f1b28a8e0 100644 --- 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> {