CronJob

CronJobs are specified very similar to Queues:

pages/api/someCronJob.ts

import { CronJob } from "quirrel/next";

export default CronJob(
  "api/someCronJob", // the route that it's reachable on
  ["0 2 * * *", "Europe/Berlin"], // every day at 2AM, in Berlin time. you can also write @weekly or @daily!
  async (job) => {
    // do something
  }
);

🚨 Other Frameworks 🚨

The example above is for Next.js. Take a look at how Queue works with your framework - it's the same for CronJob.

This creates a new CronJob, which will immediately be picked up by your local Quirrel instance:

note

During development, your local Quirrel instance is able to detect CronJob() calls by watching your source directory. To register cron jobs on deployment, run quirrel ci during deployment

note

If you're struggling with cron syntax, check out crontab guru.

note

The CronJob call is detected using regular expressions. This limits the first two parameters to static strings. Using variables won't work.