SchedulerAPI
Defined in: namespaces-core-plugins.ts:293
Trigger-kind-agnostic job engine (fn-90). Built-in triggers: interval, cron (DST-safe), notification (event-bus), fsEvents, calendar, powerState, networkState, appLaunch, plus declarative custom trigger kinds.
All methods require scheduler.job.own.
fn-90
Methods
Section titled “Methods”scheduleJob()
Section titled “scheduleJob()”scheduleJob(
spec):Promise<{token:string;jobId:string; }>
Defined in: namespaces-core-plugins.ts:295
Schedules a job. Returns an owner-scoped token + job id.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<{ token: string; jobId: string; }>
cancel()
Section titled “cancel()”cancel(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:297
Cancels (removes) a job.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
pause()
Section titled “pause()”pause(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:299
Pauses a job.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
resume()
Section titled “resume()”resume(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:301
Resumes a paused job.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
update()
Section titled “update()”update(
token,mutation):Promise<void>
Defined in: namespaces-core-plugins.ts:303
Mutates a job in place.
Parameters
Section titled “Parameters”string
mutation
Section titled “mutation”Returns
Section titled “Returns”Promise<void>
history()
Section titled “history()”history(
token,limit?):Promise<SchedulerRunResult[]>
Defined in: namespaces-core-plugins.ts:305
Returns recent run history.
Parameters
Section titled “Parameters”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<SchedulerRunResult[]>
nextFire()
Section titled “nextFire()”nextFire(
token):Promise<string|null>
Defined in: namespaces-core-plugins.ts:307
Next wall-clock fire time (ISO 8601), or null.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string | null>
triggerNow()
Section titled “triggerNow()”triggerNow(
token):Promise<SchedulerRunResult>
Defined in: namespaces-core-plugins.ts:309
Fires the job immediately through the normal dispatch pipeline.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<SchedulerRunResult>