workloads / main / Cron

Class: Cron

Workload for recurring tasks.

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

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

• run function with the code that will be executed.

Example

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

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

export default reports;

Extends

• StatelessWorkload

Constructors

new Cron()

new Cron(id, options): Cron

Parameters

Parameter	Type	Description
id	string	Unique ID
options	CronOptions	‐

Returns

Cron

Overrides

StatelessWorkload.constructor

Properties

Property	Modifier	Type	Description
id	public	string	Unique ID
options	public	CronOptions	-
run	public	() => Promise<void>	-
schedule	public	string	-