docs: added jsdoc for persistUserOnConnectionFailure

GetStream · Aug 23, 2022 · 22dd3dd · 22dd3dd
1 parent f8300e7
commit 22dd3dd
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -906,6 +906,12 @@ export type StreamChatOptions = AxiosRequestConfig & {
   /** experimental feature, please contact support if you want this feature enabled for you */
   enableWSFallback?: boolean;
   logger?: Logger;
+  /**
+   * When true, user will be persisted on client. Otherwise if `connectUser` call fails, then you need to
+   * call `connectUser` again to retry.
+   * This is mainly useful for chat application working in offline mode, where you will need client.user to
+   * persist even if connectUser call fails.
+   */
   persistUserOnConnectionFailure?: boolean;
   /**
    * When network is recovered, we re-query the active channels on client. But in single query, you can recover