Skip to content

Cron

Workload for recurring tasks.

Description

With this workload you recurring tasks for your application.

A Cron workload is initialized with a unique id and the following options:

  • schedule in unix-cron format to specify it should run.

  • run function with the code that will be executed.

ts
import { Cron } from "@monolayer/sdk";

const reports = new Cron("reports", {
  schedule: "* * * * *",
  work: () => {
    // Do something;
  },
});

export default reports;

Important

Export only one Cron workload per file as the default export.

Development environment

You can trigger a Cron workload on demand with the trigger cron CLI command.

Test environment

This workload does not have a test environment.

However, you can test the work function of a Cron in your test suite.

:::

Examples

ts
import { Cron } from "@monolayer/sdk";

const reports = new Cron("reports", {
  schedule: "* * * * *",
  work: () => {
    // Do something;
  },
});

export default reports;