Declarative schedules

[matt-aitken]

This is for this roadmap feature: https://feedback.trigger.dev/p/static-cron-attached-to-tasks

We've called them "declarative" schedules as they're declared in your code on a task like this:

export const firstScheduledTask = schedules.task({
  id: "first-scheduled-task",
  //every two hours (UTC timezone)
  cron: "0 */2 * * *",
  run: async (payload, { ctx }) => {
    //do something
  },
});

Or you can specify a timezone if you don't want UTC:

export const secondScheduledTask = schedules.task({
  id: "second-scheduled-task",
  cron: {
    //5am every day Tokyo time
    pattern: "0 5 * * *",
    timezone: "Asia/Tokyo",
  },
  run: async (payload) => {},
});

These schedules are synced when you run the dev or deploy CLI commands. If you create, edit or delete the cron property it will be reflected when this sync happens.

You can't delete, disable or enable them using the other SDK functions that work with imperative schedules.

[changeset-bot]

🦋 Changeset detected

Latest commit: d74099e

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR