DynamicSchedule: register() instance method

Use this method to register a new schedule with the DynamicSchedule.

Parameters

id · string · required

The id of the schedule to register. The identifier you use will be available in the context.source.id when the Job runs.

schedule · Schedule · required

The schedule to register. It is either a cron or interval schedule.

Show cron

type · string · required

Value is always cron

options · object · required

Hide options

cron · string · required

The cron expression to use.

metadata · any

Any additional data you wish to store with the schedule. This will be available in the context.source.metadata when the Job runs.

accountId · string

An optional account ID to use when running the job. This will be available in the Job context and can be used in auth resolvers

Show interval

type · string · required

Value is always interval

options · object · required

Hide options

seconds · number · required

The number of seconds between each trigger.

metadata · any

Any additional data you wish to store with the schedule. This will be available in the context.source.metadata when the Job runs.

accountId · string

An optional account ID to use when running the job. This will be available in the Job context and can be used in auth resolvers

Returns

id · string

The id of the schedule that was registered.

schedule · Schedule

The schedule that was registered, one of “cron” or “interval”.

Show cron

type · string · required

The type of schedule. This will always be “cron”.

options · object · required

An object containing options about the CRON schedule.

Hide options

cron · string · required

The registered CRON expression.

metadata · any · required

Any additional metadata about the interval.

Show interval

type · string · required

The type of schedule. This will always be “interval”.

options · object · required

An object containing options about the interval.

Hide options

seconds · number · required

The number of seconds for the interval. Min = 60, Max = 2_592_000 (30 days)

metadata · any · required

Any additional metadata about the interval.

metadata · any · required

Metadata about the schedule.

active · boolean · required

Whether the schedule is active or not.

cron

await dynamicSchedule.register(userId, {
  type: "cron",
  options: {
    cron: "0 0 * * *",
  },
});