Skip to content

Commit 30a77fe

Browse files
authored
docs: improve docs for waitForFinish in Actor.start (#693)
Related: https://apify.slack.com/archives/C010Q0FBYG3/p1747042200680909
1 parent 6b33328 commit 30a77fe

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/resource_clients/actor.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,9 @@ export interface ActorStartOptions {
372372
* Maximum time to wait for the actor run to finish, in seconds.
373373
* If the limit is reached, the returned promise is resolved to a run object that will have
374374
* status `READY` or `RUNNING` and it will not contain the actor run output.
375-
* If `waitForFinish` is null or undefined, the function waits for the actor to finish (default behavior).
375+
* By default (or when `waitForFinish` is set to `0`), the function resolves immediately without waiting.
376+
* The wait is limited to 60s and happens on the API directly, as opposed to the `call` method and its
377+
* `waitSecs` option, which is implemented via polling on the client side instead (and has no limit like that).
376378
*/
377379
waitForFinish?: number;
378380

0 commit comments

Comments
 (0)