Skip to content

docs: add per-task middleware section to tasks overview #3197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isshaddad wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −6
Open

docs: add per-task middleware section to tasks overview #3197

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
894109d
docs: add per-task middleware section to tasks overview
isshaddad Mar 9, 2026
d03c176
docs: use typescript fence token instead of ts in overview.mdx
isshaddad Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/tasks/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,28 @@ export const myTask = task({
});
```

#### Per-task middleware

You can also define middleware per task by passing the `middleware` option in the task definition. This runs after global middleware and before the `run` function. Use it when only specific tasks need certain locals or setup:

```ts
import { task, locals } from "@trigger.dev/sdk";

const myLocal = locals.create<string>("myLocal");

export const myTask = task({
id: "my-task",
middleware: async ({ payload, ctx, next }) => {
locals.set(myLocal, "some-value");
await next();
},
run: async (payload) => {
const value = locals.getOrThrow(myLocal);
// ...
},
});
```

### `onStartAttempt` function

<Info>The `onStartAttempt` function was introduced in v4.1.0</Info>
Expand Down