CronJob
Auto-generated API reference for CronJob.
Interface: CronJob<TContext>
Defined in: background.ts:13
#Type Parameters
#TContext
TContext = unknown
#Properties
#agent
agent:
AgentHandle<TContext>
Defined in: background.ts:16
#context?
optionalcontext?:TContext
Defined in: background.ts:19
#runOnStart?
optionalrunOnStart?:boolean
Defined in: background.ts:21
Run the job exactly once on start before the first tick.
#schedule
schedule:
string
Defined in: background.ts:15
Standard 5-field cron (* * * * *) or an every:<ms> shortcut.
#task?
optionaltask?:string| ((now) =>string)
Defined in: background.ts:18
Task the agent receives each fire. Default: scheduled: <name>.