Skip to content

Commit d5c25e6

Browse files
committed
Adds more clarity to the run with TTL docs section
1 parent b5c5b67 commit d5c25e6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/runs.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,9 @@ You can set a TTL when triggering a run:
133133
await yourTask.trigger({ foo: "bar" }, { ttl: "10m" });
134134
```
135135

136-
If the run hasn't started within the specified TTL, it will automatically expire. This is useful for time-sensitive tasks. Note that dev runs automatically have a 10-minute TTL.
136+
If the run hasn't started within the specified TTL, it will automatically expire, returning the status `Expired`. This is useful for time-sensitive tasks where immediate execution is important. For example, when you queue many runs simultaneously and exceed your concurrency limits, some runs might be delayed - using TTL ensures they only execute if they can start within your specified timeframe.
137+
138+
Note that dev runs automatically have a 10-minute TTL. In Staging and Production environments, no TTL is set by default.
137139

138140
![Run with TTL](/images/run-with-ttl.png)
139141

0 commit comments

Comments
 (0)