James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
42 lines
1.2 KiB
Plaintext
42 lines
1.2 KiB
Plaintext
---
|
|
title: "Wait for"
|
|
description: "Wait for a period of time, then continue execution."
|
|
---
|
|
|
|
import PausedExecutionFree from "/snippets/paused-execution-free.mdx"
|
|
|
|
Inside your tasks you can wait for a period of time before you want execution to continue.
|
|
|
|
```ts /trigger/long-task.ts
|
|
export const veryLongTask = task({
|
|
id: "very-long-task",
|
|
run: async (payload) => {
|
|
await wait.for({ seconds: 5 });
|
|
|
|
await wait.for({ minutes: 10 });
|
|
|
|
await wait.for({ hours: 1 });
|
|
|
|
await wait.for({ days: 1 });
|
|
|
|
await wait.for({ weeks: 1 });
|
|
|
|
await wait.for({ months: 1 });
|
|
|
|
await wait.for({ years: 1 });
|
|
},
|
|
});
|
|
```
|
|
|
|
This allows you to write linear code without having to worry about the complexity of scheduling or managing cron jobs.
|
|
|
|
<PausedExecutionFree />
|
|
|
|
## Wait idempotency
|
|
|
|
You can pass an idempotency key to any wait function, allowing you to skip waits if the same idempotency key is used again. This can be useful if you want to skip waits when retrying a task, for example:
|
|
|
|
```ts
|
|
// Specify the idempotency key and TTL when waiting for a duration:
|
|
await wait.for({ seconds: 10 }, { idempotencyKey: "my-idempotency-key", idempotencyKeyTTL: "1h" });
|
|
``` |