tweak docs

segmentio · Sep 29, 2022 · 21b2ea0 · 21b2ea0
1 parent b5df7e7
commit 21b2ea0
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/node/src/app/analytics-node.ts b/packages/node/src/app/analytics-node.ts
@@ -107,12 +107,13 @@ export class AnalyticsNode
 
   /**
    * Call this method to stop collecting new events and flush all existing events.
-   * If a callback on an event call is incluced, this also waits for all callbacks to be called, and any of their subsequent promises to be resolved.
+   * This method also waits for any event method-specific callbacks to be triggered,
+   * and any of their subsequent promises to be resolved/rejected.
    */
   public closeAndFlush({
     timeout,
   }: {
-    /** Maximum time permitted to wait before resolving. */
+    /** Set a maximum time permitted to wait before resolving. Default = no maximum. */
     timeout?: number
   } = {}): Promise<void> {
     this._isClosed = true