Skip to content

add headings in cds.queued() docs #1885

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

Merged
renejeglinsky merged 2 commits into from
Jun 3, 2025
Merged

add headings in cds.queued() docs #1885

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d15ef2f
add headings
sjvans May 28, 2025
1f7b479
Merge branch 'main' into task-queues-java
sjvans May 28, 2025
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
5 changes: 5 additions & 0 deletions node.js/queue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,8 @@ Finally, entries in the dead letter queue can either be _revived_ by resetting t

### Additional APIs <Alpha />

#### Task Scheduling

You can use the `schedule` method as a shortcut for `cds.queued(srv).send()`, with optional scheduling options `after` and `every`:

```js
Expand All @@ -236,6 +238,7 @@ await srv.schedule('someEvent', { some: 'message' }).after('1h') // after one ho
await srv.schedule('someEvent', { some: 'message' }).every('1h') // every hour after each processing
```

#### Task Processing

To manually trigger the message processing, for example if your server is restarted, you can use the `flush` method.

Expand All @@ -244,6 +247,8 @@ const srv = await cds.connect.to('yourService')
cds.queued(srv).flush()
```

#### Task Callbacks

Once a message has been successfully processed, it triggers the `<event>/#succeeded` handlers.

```js
Expand Down