HocuspocusProvider: adds comment the new feature to disable Awareness

ueberdosis · Aug 12, 2023 · 9cb0b54 · 9cb0b54
1 parent f6e10f6
commit 9cb0b54
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/provider/src/HocuspocusProvider.ts b/packages/provider/src/HocuspocusProvider.ts
@@ -58,6 +58,11 @@ export interface CompleteHocuspocusProviderConfiguration {
   broadcast: boolean,
   /**
    * An Awareness instance to keep the presence state of all clients.
+   *
+   * You can disable sharing awareness information by passing `null`.
+   * Note that having no awareness information shared across all connections will break our ping checks
+   * and thus trigger reconnects. You should always have at least one Provider with enabled awareness per
+   * socket connection, or ensure that the Provider receives messages before running into `HocuspocusProviderWebsocket.messageReconnectTimeout`.
    */
   awareness: Awareness | null,
   /**