io.registerCron()
io.registerCron() allows you to register a DynamicSchedule that will trigger any jobs it's attached to on a regular CRON schedule.
This has been deprecated in favor of DynamicSchedule.register
Parameters
Should be a stable and unique key inside the run(). See
resumability for more information.
A DynamicSchedule that will trigger any Jobs it’s attached to on a regular interval.
A unique id for the schedule. This is used to identify and unregister the schedule later.
An object containing options about the interval.
A CRON expression that defines the schedule. A useful tool when writing CRON expressions is crontab guru. Note that the timezone used is UTC.
Returns
A Promise that resolves to an object with the following fields:
A unique id for the interval. This is used to identify and unregister the interval later.
Any additional metadata about the interval.
This will be used by the Trigger.dev Connect feature, which is coming soon.
The type of schedule. This will always be “cron”.
An object containing options about the CRON schedule.
The registered CRON expression.
Any additional metadata about the interval.
client.defineJob({
id: "my-job",
name: "My job",
version: "0.1.1",
trigger: eventTrigger({
name: "dynamic.cron",
schema: z.object({
id: z.string(),
cron: z.string(),
}),
}),
run: async (payload, io, ctx) => {
//registers a DynamicSchedule with a CRON expression
await io.registerCron("register-cron", dynamicSchedule, payload.id, {
cron: payload.cron,
});
},
});
Was this page helpful?
client.defineJob({
id: "my-job",
name: "My job",
version: "0.1.1",
trigger: eventTrigger({
name: "dynamic.cron",
schema: z.object({
id: z.string(),
cron: z.string(),
}),
}),
run: async (payload, io, ctx) => {
//registers a DynamicSchedule with a CRON expression
await io.registerCron("register-cron", dynamicSchedule, payload.id, {
cron: payload.cron,
});
},
});