de302858f8
* Started building out the docs navigation * Drafted out a lot of the docs pages. With just titles and descriptions with a coming soon message for now. * A ton more scaffolded pages with titles, descriptions, coming soon/incomplete docs messages * Created the remaining page stubs * Introduction page improvements * Lots of docs changes, mostly the task overview page * Moved some bits around * Task overview fleshed out * Triggering docs page * Regular task page * CLi dev docs * Docs for debugging locally * Environment variables docs * Added env var images * Deployment guides * Updated the title of “Integrations” to “Deployment integrations” to make it less confusing * Lots more docs pages * Changed the language to JavaScript * Fixed typos about queues and added a simple code sample * Moved the local debugger docs into the CLI dev page * Added the CLI deploy options * Delete the local debugger page * Updated the logging page with structured logging * Added the new CLI deploy options * Change to h4 for one of the options * Errors page * WIP on retrying * Retrying guide * Wait docs pages * Queuing docs simplified, partial written * Queuing and concurrency docs * Run tests docs * New combined error and retrying page * Errors and retrying page updated * More docs * Added a possible configurations coming soon table * Created a limits page * Added warnings about how you need to get early access * Minor fixes for the docs
87 lines
2.8 KiB
Plaintext
87 lines
2.8 KiB
Plaintext
---
|
|
title: "Regular tasks"
|
|
description: "The simplest type of task which can be triggered from elsewhere in your code."
|
|
---
|
|
|
|
They are defined using the `task()` function and can be [triggered](/v3/triggering) from your backend or inside another task.
|
|
|
|
Like all tasks they don't have timeouts, they should be placed inside a [/trigger folder](/v3/trigger-folder), and you [can configure them](/v3/tasks-overview#defining-a-task).
|
|
|
|
## Example tasks
|
|
|
|
### A task that does an OpenAI call with retrying
|
|
|
|
Sometimes OpenAI calls can take a long time to complete, or they can fail. This task will retry if the API call fails completely or if the response is empty.
|
|
|
|
<Snippet file="v3/code/openai-retry.mdx" />
|
|
|
|
### A Task that sends emails in a sequence with delays in between
|
|
|
|
This example uses Resend to send a sequence of emails over several days.
|
|
|
|
Each email is wrapped in [retry.onThrow](/v3/reference-retry-on-throw). This will retry the block of code if an error is thrown. This is useful when you don't want to retry the whole task, but just a part of it. The entire task will use the default retrying, so can also retry.
|
|
|
|
Additionally this task uses `wait.for` to wait for a certain amount of time before sending the next email. During the waiting time, the task will be paused and will not consume any resources.
|
|
|
|
```ts /trigger/email-sequence.ts
|
|
import { Resend } from "resend";
|
|
|
|
const resend = new Resend(process.env.RESEND_ASP_KEY);
|
|
|
|
export const emailSequence = task({
|
|
id: "email-sequence",
|
|
run: async (payload: { userId: string; email: string; name: string }) => {
|
|
console.log(`Start email sequence for user ${payload.userId}`, payload);
|
|
|
|
//send the first email immediately
|
|
const firstEmailResult = await retry.onThrow(
|
|
async ({ attempt }) => {
|
|
const { data, error } = await resend.emails.send({
|
|
from: "hello@trigger.dev",
|
|
to: payload.email,
|
|
subject: "Welcome to Trigger.dev",
|
|
html: `<p>Hello ${payload.name},</p><p>Welcome to Trigger.dev</p>`,
|
|
});
|
|
|
|
if (error) {
|
|
//throwing an error will trigger a retry of this block
|
|
throw error;
|
|
}
|
|
|
|
return data;
|
|
},
|
|
{ maxAttempts: 3 }
|
|
);
|
|
|
|
//then wait 3 days
|
|
await wait.for({ days: 3 });
|
|
|
|
//send the second email
|
|
const secondEmailResult = await retry.onThrow(
|
|
async ({ attempt }) => {
|
|
const { data, error } = await resend.emails.send({
|
|
from: "hello@trigger.dev",
|
|
to: payload.email,
|
|
subject: "Some tips for you",
|
|
html: `<p>Hello ${payload.name},</p><p>Here are some tips for you…</p>`,
|
|
});
|
|
|
|
if (error) {
|
|
//throwing an error will trigger a retry of this block
|
|
throw error;
|
|
}
|
|
|
|
return data;
|
|
},
|
|
{ maxAttempts: 3 }
|
|
);
|
|
|
|
//etc...
|
|
},
|
|
});
|
|
```
|
|
|
|
### Other examples
|
|
|
|
<Snippet file="incomplete-docs.mdx" />
|