Skip to content

C3: Improve cron/scheduled template docs #5547

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
petebacondarwin merged 2 commits into from
May 15, 2024
Merged

C3: Improve cron/scheduled template docs #5547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3566299
docs: improve cron C3 template docs
connorads Apr 7, 2024
bc11264
fix: provide a simple fetch handler to the scheduled template to avoi…
petebacondarwin Apr 22, 2024
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
7 changes: 7 additions & 0 deletions .changeset/ninety-trainers-attack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"create-cloudflare": patch
---

fix: provide a simple fetch handler to the scheduled template to avoid confusing error messages.

Fixes #4560
4 changes: 2 additions & 2 deletions packages/create-cloudflare/templates/scheduled/js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"private": true,
"scripts": {
"deploy": "wrangler deploy",
"dev": "wrangler dev",
"start": "wrangler dev"
"dev": "wrangler dev --test-scheduled",
"start": "wrangler dev --test-scheduled"
},
"devDependencies": {
"wrangler": "^3.0.0"
Expand Down
9 changes: 8 additions & 1 deletion packages/create-cloudflare/templates/scheduled/js/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,20 @@
* https://developers.cloudflare.com/workers/platform/triggers/cron-triggers/
*
* - Run `npm run dev` in your terminal to start a development server
* - Open a browser tab at http://localhost:8787/ to see your worker in action
* - Run `curl "http://localhost:8787/__scheduled?cron=*+*+*+*+*"` to see your worker in action
* - Run `npm run deploy` to publish your worker
*
* Learn more at https://developers.cloudflare.com/workers/
*/

export default {
async fetch(req) {
const url = new URL(req.url)
url.pathname = "/__scheduled";
url.searchParams.append("cron", "* * * * *");
return new Response(`To test the scheduled handler, ensure you have used the "--test-scheduled" then try running "curl ${url.href}".`);
},

// The scheduled handler is invoked at the interval set in our wrangler.toml's
// [[triggers]] configuration.
async scheduled(event, env, ctx) {
Expand Down
4 changes: 2 additions & 2 deletions packages/create-cloudflare/templates/scheduled/ts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"private": true,
"scripts": {
"deploy": "wrangler deploy",
"dev": "wrangler dev",
"start": "wrangler dev",
"dev": "wrangler dev --test-scheduled",
"start": "wrangler dev --test-scheduled",
"cf-typegen": "wrangler types"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/create-cloudflare/templates/scheduled/ts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* https://developers.cloudflare.com/workers/platform/triggers/cron-triggers/
*
* - Run `npm run dev` in your terminal to start a development server
* - Open a browser tab at http://localhost:8787/ to see your worker in action
* - Run `curl "http://localhost:8787/__scheduled?cron=*+*+*+*+*"` to see your worker in action
* - Run `npm run deploy` to publish your worker
*
* Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
Expand Down