Skip to content

docs: add tip for timeout + fresh error stacks #909

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
timkelty wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add tip for timeout + fresh error stacks #909

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ef9a10
docs: explain timeout exception factory stacks
timkelty Sep 20, 2026
5c897e9
docs: add timeout exception factory example
timkelty Sep 20, 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
15 changes: 15 additions & 0 deletions docs/middleware/builtin/timeout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,21 @@ app.get('/api/long-process', async (c) => {
})
```

::: tip Fresh error stacks

Use a factory when timeout errors are reported to an observability service:

```ts
timeout(
5000,
() => new HTTPException(504, { message: 'Gateway Timeout' })
)
```

Passing an exception instance reuses its construction-time stack for every timeout, which can affect stack attribution and error fingerprinting.

:::

## Notes

- The duration for the timeout can be specified in milliseconds. The middleware will automatically reject the promise and potentially throw an error if the specified duration is exceeded.
Expand Down