You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(docs): Add clarifications for delay semantics and payload handling (#2928)
Adds documentation notes clarifying that:
- delayed runs execute on the current deployment version
- guidance for Date objects in payloads
- static IP availability
- version locking behavior for delayed runs
If your payload contains Date objects, pass them directly rather than manually stringifying with
739
+
`JSON.stringify()`. The SDK handles Date serialization automatically. If you need to stringify
740
+
manually, convert Dates to ISO strings first (e.g., `date.toISOString()`).
741
+
</Note>
742
+
736
743
### `ttl`
737
744
738
745
You can set a TTL (time to live) when triggering a task, which will automatically expire the run if it hasn't started within the specified time. This is useful for ensuring that a run doesn't get stuck in the queue for too long.
@@ -1048,7 +1055,7 @@ You can override the default region when you trigger a run:
If you don't specify a region it will use the default for your project. Go to the "Regions" page in the dashboard to see available regions or switch your default.
1058
+
If you don't specify a region it will use the default for your project. Go to the "Regions" page in the dashboard to see available regions or switch your default. Static IP addresses are also available on the Regions page for paid plans.
1052
1059
1053
1060
The region is where your runs are executed, it does not change where the run payload, output, tags, logs, or are any other data is stored.
Copy file name to clipboardExpand all lines: docs/versioning.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,8 @@ Versions numbers are incremented each time a new version is created for that dat
24
24
25
25
When a task run starts it is locked to the latest version of the code (for that environment). Once locked it won't change versions, even if you deploy new versions. This is to ensure that a task run is not affected by changes to the code.
26
26
27
+
Delayed runs are locked to the version that's active when they begin executing, not when they're enqueued.
28
+
27
29
### Child tasks and version locking
28
30
29
31
Trigger and wait functions version lock child task runs to the parent task run version. This ensures the results from child runs match what the parent task is expecting. If you don't wait then version locking doesn't apply.
0 commit comments