docs(solidstart): add cron jobs guide using Nitro Tasks API#1534
docs(solidstart): add cron jobs guide using Nitro Tasks API#1534harshagarwalnyu wants to merge 2 commits into
Conversation
Documents how to set up scheduled background tasks in SolidStart using Nitro's Tasks API. Covers configuration in app.config.ts, task file structure in tasks/ directory, and manual triggering via the Nitro task endpoint. Closes solidjs#964
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a new SolidStart guide explaining how to schedule and run cron-like background jobs using Nitro’s Tasks API.
Changes:
- Introduces documentation for enabling Nitro tasks in
app.config.tsand mapping cron expressions viascheduledTasks. - Documents creating a task in the root
tasks/directory with a minimaldefineTaskexample. - Describes triggering tasks manually via the Nitro tasks endpoint for development/testing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Running tasks on demand | ||
|
|
||
| You can trigger a task manually by calling the Nitro task endpoint during development: |
There was a problem hiding this comment.
Good catch. Addressed in 0a0bd4f by adding a :::caution block right after the endpoint example, warning that /_nitro/tasks/* executes server-side code on demand and is publicly reachable by default in the production presets (node-server, bun, deno-server). It now tells readers to protect it behind auth, IP allowlisting, or route-level middleware before deploying.
| ## Running tasks on demand | ||
|
|
||
| You can trigger a task manually by calling the Nitro task endpoint during development: | ||
|
|
There was a problem hiding this comment.
Fixed in 0a0bd4f. Swapped the bare /_nitro/tasks/cron line for a sh fenced curl http://localhost:3000/_nitro/tasks/cron example so the GET method and full URL are explicit.
- Add caution block warning that /_nitro/tasks/* is publicly accessible in production (node-server, bun, deno-server) and should be protected - Add curl example with explicit GET method for task triggering
Adds a new cron jobs guide to the SolidStart guides section, addressing #964.
The guide covers:
app.config.tstasks/directory (notsrc/tasks/)defineTaskAPI fromnitropack/runtime/_nitro/tasks/<name>for testingContent is based on the working example shared in the issue. The guide also clarifies the
nitropackdev dependency situation since it's a transitive dep that TypeScript sometimes can't resolve without an explicit install.Closes #964