Update the documentation for the default timeout value (#4681)

* Update the documentation for the default timout value * update comment
statelyai · Jan 16, 2024 · c11e4c2 · c11e4c2
1 parent 2ba2d7f
commit c11e4c2
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/packages/core/src/waitFor.ts b/packages/core/src/waitFor.ts
@@ -6,7 +6,7 @@ interface WaitForOptions {
    * How long to wait before rejecting, if no emitted
    * state satisfies the predicate.
    *
-   * @defaultValue 10_000 (10 seconds)
+   * @defaultValue Infinity
    */
   timeout: number;
 }
@@ -18,8 +18,8 @@ const defaultWaitForOptions: WaitForOptions = {
 /**
  * Subscribes to an actor ref and waits for its emitted value to satisfy
  * a predicate, and then resolves with that value.
- * Will throw if the desired state is not reached after a timeout
- * (defaults to 10 seconds).
+ * Will throw if the desired state is not reached after an optional timeout.
+ * (defaults to Infinity).
  *
  * @example
  * ```js