Skip to content

improve docs & examples - #6

Merged
ianmacartney merged 6 commits into
mainfrom
ian/readme-batch-docs-blog
Jul 23, 2026
Merged

ianmacartney merged 6 commits into
mainfrom
ian/readme-batch-docs-blog

Conversation

@ianmacartney

@ianmacartney ianmacartney commented Jul 22, 2026 •

Copy link
Copy Markdown
Member
  • improve examples
  • update readme

Copy link
Copy Markdown
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@pkg-pr-new

pkg-pr-new Bot commented Jul 22, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@convex-dev/batch-worker@6

commit: a0023b0

@ianmacartney
ianmacartney marked this pull request as ready for review July 22, 2026 02:22
@ianmacartney
ianmacartney requested a review from reeceyang July 22, 2026 02:22

Copy link
Copy Markdown
Member Author

Ideally with these changes, agents will be able to use BatchWorker without much guidance. @jamescowling FYI

@ianmacartney ianmacartney changed the title improve examples improve docs & examples Jul 22, 2026
Comment thread README.md

Run a single background "main loop" over work you insert into your own table —
with scheduling, debouncing, and recovery built in.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we can also mention that the loop processes batches of work in this summary sentence? Maybe something like

Process batches of work by defining singleton workers that automatically loop over your table —
with scheduling, debouncing, and recovery built in.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good suggestion - updated

@ianmacartney
ianmacartney merged commit 2348541 into main Jul 23, 2026
2 checks passed
@ianmacartney
ianmacartney deleted the ian/readme-batch-docs-blog branch August 11, 2026 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants