docs: add a section about event.waitUntil

This commit is contained in:
Matej Cerny 2024-10-16 22:11:31 +02:00
parent 560f176c09
commit 09b6eea574
No known key found for this signature in database
GPG Key ID: 15909945A8C43C38

View File

@ -363,6 +363,35 @@ Headers that are **not meant to be forwarded** will **not be included** in the r
`transfer-encoding`, `connection`, `keep-alive`, `upgrade`, `expect`, `host`, `accept`
::
### Background Tasks Without Delaying Responses
When handling server requests, you might need to perform asynchronous tasks that shouldn't block the response to the client.
Use `event.waitUntil` to schedule these tasks to run in the background without delaying the response.
The `event.waitUntil` method accepts a promise that will be awaited before the handler terminates,
ensuring the task is completed even if the server would otherwise terminate the handler right after the response is sent.
This integrates with hosting providers to leverage their native capabilities for handling asynchronous
operations after the response is sent.
```ts [server/api/background-task.ts]
const timeConsumingBackgroundTask = async () => {
await new Promise((resolve) => setTimeout(resolve, 1000))
};
export default eventHandler((event) => {
// schedule a background task without blocking the response
event.waitUntil(timeConsumingBackgroundTask())
// immediately send the response to the client
return 'done'
});
```
::note
This feature is experimental.
::
## Advanced Usage
### Nitro Config