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>
66 lines
1.8 KiB
Plaintext
66 lines
1.8 KiB
Plaintext
---
|
|
title: Errors and retries
|
|
sidebarTitle: Errors and retries
|
|
description: Handling errors and retries with the Trigger.dev management API
|
|
---
|
|
|
|
## Handling errors
|
|
|
|
When the SDK method is unable to connect to the API server, or the API server returns a non-successful response, the SDK will throw an `ApiError` that you can catch and handle:
|
|
|
|
```ts
|
|
import { runs, APIError } from "@trigger.dev/sdk";
|
|
|
|
async function main() {
|
|
try {
|
|
const run = await runs.retrieve("run_1234");
|
|
} catch (error) {
|
|
if (error instanceof ApiError) {
|
|
console.error(`API error: ${error.status}, ${error.headers}, ${error.body}`);
|
|
} else {
|
|
console.error(`Unknown error: ${error.message}`);
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Retries
|
|
|
|
The SDK will automatically retry requests that fail due to network errors or server errors. By default, the SDK will retry requests up to 3 times, with an exponential backoff delay between retries.
|
|
|
|
You can customize the retry behavior by passing a `requestOptions` option to the `configure` function:
|
|
|
|
```ts
|
|
import { configure } from "@trigger.dev/sdk";
|
|
|
|
configure({
|
|
requestOptions: {
|
|
retry: {
|
|
maxAttempts: 5,
|
|
minTimeoutInMs: 1000,
|
|
maxTimeoutInMs: 5000,
|
|
factor: 1.8,
|
|
randomize: true,
|
|
},
|
|
},
|
|
});
|
|
```
|
|
|
|
All SDK functions also take a `requestOptions` parameter as the last argument, which can be used to customize the request options. You can use this to disable retries for a specific request:
|
|
|
|
```ts
|
|
import { runs } from "@trigger.dev/sdk";
|
|
|
|
async function main() {
|
|
const run = await runs.retrieve("run_1234", {
|
|
retry: {
|
|
maxAttempts: 1, // Disable retries
|
|
},
|
|
});
|
|
}
|
|
```
|
|
|
|
<Note>
|
|
When running inside a task, the SDK ignores customized retry options for certain functions (e.g.,
|
|
`task.trigger`, `task.batchTrigger`), and uses retry settings optimized for task execution.
|
|
</Note> |