Improved maxDuration comments in the templates

triggerdotdev · Nov 7, 2024 · 71808fa · 71808fa
1 parent 82ebfc7
commit 71808fa
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/packages/cli-v3/templates/examples/schedule.mjs.template b/packages/cli-v3/templates/examples/schedule.mjs.template
@@ -2,9 +2,10 @@ import { logger, schedules, wait } from "@trigger.dev/sdk/v3";
 
 export const firstScheduledTask = schedules.task({
   id: "first-scheduled-task",
-  //every hour
+  // Every hour
   cron: "0 * * * *",
-  maxDuration: 300, // 5 minutes
+  // Set an optional maxDuration to prevent tasks from running indefinitely
+  maxDuration: 300, // Stop executing after 300 secs (5 mins) of compute
   run: async (payload, { ctx }) => {
     // The payload contains the last run timestamp that you can use to check if this is the first run
     // And calculate the time since the last run

diff --git a/packages/cli-v3/templates/examples/schedule.ts.template b/packages/cli-v3/templates/examples/schedule.ts.template
@@ -2,9 +2,10 @@ import { logger, schedules, wait } from "@trigger.dev/sdk/v3";
 
 export const firstScheduledTask = schedules.task({
   id: "first-scheduled-task",
-  //every hour
+  // Every hour
   cron: "0 * * * *",
-  maxDuration: 300, // 5 minutes
+  // Set an optional maxDuration to prevent tasks from running indefinitely
+  maxDuration: 300, // Stop executing after 300 secs (5 mins) of compute
   run: async (payload, { ctx }) => {
     // The payload contains the last run timestamp that you can use to check if this is the first run
     // And calculate the time since the last run

diff --git a/packages/cli-v3/templates/examples/simple.mjs.template b/packages/cli-v3/templates/examples/simple.mjs.template
@@ -2,7 +2,8 @@ import { logger, task, wait } from "@trigger.dev/sdk/v3";
 
 export const helloWorldTask = task({
   id: "hello-world",
-  maxDuration: 300, // 5 minutes
+  // Set an optional maxDuration to prevent tasks from running indefinitely
+  maxDuration: 300, // Stop executing after 300 secs (5 mins) of compute
   run: async (payload, { ctx }) => {
     logger.log("Hello, world!", { payload, ctx });
 

diff --git a/packages/cli-v3/templates/examples/simple.ts.template b/packages/cli-v3/templates/examples/simple.ts.template
@@ -2,7 +2,8 @@ import { logger, task, wait } from "@trigger.dev/sdk/v3";
 
 export const helloWorldTask = task({
   id: "hello-world",
-  maxDuration: 300, // 5 minutes
+  // Set an optional maxDuration to prevent tasks from running indefinitely
+  maxDuration: 300, // Stop executing after 300 secs (5 mins) of compute
   run: async (payload: any, { ctx }) => {
     logger.log("Hello, world!", { payload, ctx });