Interface: KernelJobsApi
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:348
Methods
ack()
ack(
jobId,outcome):Promise<{acknowledged:boolean; }>
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:375
Report the outcome of a dispatch (rev4 stage 5). Idempotent: acks for finished, never-dispatched or DLQ jobs are no-ops.
Parameters
jobId
string
outcome
error?
string
ok
boolean
Returns
Promise<{ acknowledged: boolean; }>
cancel()
cancel(
jobId):Promise<unknown>
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:369
Parameters
jobId
string
Returns
Promise<unknown>
list()
list():
Promise<{items:KernelJob[]; }>
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:370
Returns
Promise<{ items: KernelJob[]; }>
onRun()
onRun(
callback):Unregister
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:379
Handle due-job dispatches; a new subscription replaces the previous.
Parameters
callback
(context) => unknown
Returns
retry()
retry(
jobId):Promise<unknown>
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:377
Re-enqueue a DLQ job; it fires on the next runner scan.
Parameters
jobId
string
Returns
Promise<unknown>
schedule()
schedule(
spec):Promise<{jobId:string; }>
Defined in: packages/plugin-sdk/src/kernel/authoring.ts:349
Parameters
spec
cron?
string
5-field cron (minute hour dom month dow); exclusive with the above.
intervalMs?
number
Fixed-interval schedule; fires one interval after scheduling.
name
string
payload?
unknown
retries?
number
Retry budget: after the initial failure the job may fail this many
more times before landing in the DLQ (0 = no retries, fire-and-forget).
With retries > 0 the dispatch is held until ack reports the
outcome; a missing ack times out server-side after 5 minutes and
counts as a failed attempt.
retryDelayMs?
number
Base backoff in ms; each retry doubles it (default 5000, cap 1h).
runAt?
number
One-shot at this epoch ms (fire-and-forget unless retries).
Returns
Promise<{ jobId: string; }>