From 99f59639d13c32d0fad062994e4c7c53ef04db41 Mon Sep 17 00:00:00 2001
From: Thomas Desmond <24610108+thomas-desmond@users.noreply.github.com>
Date: Fri, 7 Mar 2025 11:36:53 -0800
Subject: [PATCH 1/3] docs: Add examples for scheduled handlers in Cron
Triggers documentation
---
.../workers/configuration/cron-triggers.mdx | 31 ++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)
diff --git a/src/content/docs/workers/configuration/cron-triggers.mdx b/src/content/docs/workers/configuration/cron-triggers.mdx
index 1b028e7b72d8ab..e7bf0599d6b746 100644
--- a/src/content/docs/workers/configuration/cron-triggers.mdx
+++ b/src/content/docs/workers/configuration/cron-triggers.mdx
@@ -27,7 +27,36 @@ Cron Triggers execute on UTC time.
To respond to a Cron Trigger, you must add a [`"scheduled"` handler](/workers/runtime-apis/handlers/scheduled/) to your Worker.
-Refer to the following examples to write your code:
+import { TabItem, Tabs } from "~/components";
+
+
+
+```js
+export default {
+ async scheduled(event, env, ctx) {
+ console.log("cron processed");
+ },
+};
+```
+
+
+
+```ts
+interface Env {}
+export default {
+ async scheduled(
+ controller: ScheduledController,
+ env: Env,
+ ctx: ExecutionContext,
+ ) {
+ console.log("cron processed");
+ },
+};
+```
+
+
+
+Refer to the following additional examples to write your code:
- [Setting Cron Triggers](/workers/examples/cron-trigger/)
- [Multiple Cron Triggers](/workers/examples/multiple-cron-triggers/)
From 208ae4587dd3c7df00a3499a29459beb645bca42 Mon Sep 17 00:00:00 2001
From: Thomas Desmond <24610108+thomas-desmond@users.noreply.github.com>
Date: Fri, 7 Mar 2025 15:08:24 -0800
Subject: [PATCH 2/3] fix: Update Cron Triggers documentation to use TypeScript
example component
---
.../workers/configuration/cron-triggers.mdx | 18 +++---------------
1 file changed, 3 insertions(+), 15 deletions(-)
diff --git a/src/content/docs/workers/configuration/cron-triggers.mdx b/src/content/docs/workers/configuration/cron-triggers.mdx
index e7bf0599d6b746..d1d527523d5e5a 100644
--- a/src/content/docs/workers/configuration/cron-triggers.mdx
+++ b/src/content/docs/workers/configuration/cron-triggers.mdx
@@ -27,20 +27,9 @@ Cron Triggers execute on UTC time.
To respond to a Cron Trigger, you must add a [`"scheduled"` handler](/workers/runtime-apis/handlers/scheduled/) to your Worker.
-import { TabItem, Tabs } from "~/components";
-
-
-
-```js
-export default {
- async scheduled(event, env, ctx) {
- console.log("cron processed");
- },
-};
-```
-
-
+import { TypeScriptExample } from "~/components";
+
```ts
interface Env {}
export default {
@@ -53,8 +42,7 @@ export default {
},
};
```
-
-
+
Refer to the following additional examples to write your code:
From 5e171d573244823ad29b5b6037793e4318ce93f6 Mon Sep 17 00:00:00 2001
From: kodster28
Date: Mon, 10 Mar 2025 08:55:12 -0500
Subject: [PATCH 3/3] Reformat
---
.../workers/configuration/cron-triggers.mdx | 21 ++-----------
.../docs/workers/examples/cron-trigger.mdx | 31 ++-----------------
.../partials/workers/cron-trigger-example.mdx | 20 ++++++++++++
3 files changed, 24 insertions(+), 48 deletions(-)
create mode 100644 src/content/partials/workers/cron-trigger-example.mdx
diff --git a/src/content/docs/workers/configuration/cron-triggers.mdx b/src/content/docs/workers/configuration/cron-triggers.mdx
index d1d527523d5e5a..8e777a6771fdc4 100644
--- a/src/content/docs/workers/configuration/cron-triggers.mdx
+++ b/src/content/docs/workers/configuration/cron-triggers.mdx
@@ -5,7 +5,7 @@ head: []
description: Enable your Worker to be executed on a schedule.
---
-import { WranglerConfig } from "~/components";
+import { Render, WranglerConfig } from "~/components";
## Background
@@ -27,22 +27,7 @@ Cron Triggers execute on UTC time.
To respond to a Cron Trigger, you must add a [`"scheduled"` handler](/workers/runtime-apis/handlers/scheduled/) to your Worker.
-import { TypeScriptExample } from "~/components";
-
-
-```ts
-interface Env {}
-export default {
- async scheduled(
- controller: ScheduledController,
- env: Env,
- ctx: ExecutionContext,
- ) {
- console.log("cron processed");
- },
-};
-```
-
+
Refer to the following additional examples to write your code:
@@ -74,8 +59,6 @@ crons = [ "*/3 * * * *", "0 15 1 * *", "59 23 LW * *" ]
You also can set a different Cron Trigger for each [environment](/workers/wrangler/environments/) in your [Wrangler configuration file](/workers/wrangler/configuration/). You need to put the `[triggers]` table under your chosen environment. For example:
-
-
```toml
diff --git a/src/content/docs/workers/examples/cron-trigger.mdx b/src/content/docs/workers/examples/cron-trigger.mdx
index 8bf9e34325dcad..87b5b10c67635a 100644
--- a/src/content/docs/workers/examples/cron-trigger.mdx
+++ b/src/content/docs/workers/examples/cron-trigger.mdx
@@ -13,34 +13,9 @@ sidebar:
description: Set a Cron Trigger for your Worker.
---
-import { TabItem, Tabs, WranglerConfig } from "~/components";
+import { Render, TabItem, Tabs, WranglerConfig } from "~/components";
-
-
-```js
-export default {
- async scheduled(event, env, ctx) {
- console.log("cron processed");
- },
-};
-```
-
-
-
-```ts
-interface Env {}
-export default {
- async scheduled(
- controller: ScheduledController,
- env: Env,
- ctx: ExecutionContext,
- ) {
- console.log("cron processed");
- },
-};
-```
-
-
+
## Set Cron Triggers in Wrangler
@@ -63,8 +38,6 @@ crons = ["0 * * * *"]
You also can set a different Cron Trigger for each [environment](/workers/wrangler/environments/) in your [Wrangler configuration file](/workers/wrangler/configuration/). You need to put the `[triggers]` table under your chosen environment. For example:
-
-
```toml
diff --git a/src/content/partials/workers/cron-trigger-example.mdx b/src/content/partials/workers/cron-trigger-example.mdx
new file mode 100644
index 00000000000000..e75e7b91757b68
--- /dev/null
+++ b/src/content/partials/workers/cron-trigger-example.mdx
@@ -0,0 +1,20 @@
+---
+{}
+---
+
+import { TypeScriptExample } from "~/components";
+
+
+```ts
+interface Env {}
+export default {
+ async scheduled(
+ controller: ScheduledController,
+ env: Env,
+ ctx: ExecutionContext,
+ ) {
+ console.log("cron processed");
+ },
+};
+```
+