TriggerJob

import type { TriggerJob } from "@elie-laloum/outpost";

Parameters and properties

handlerRequired
string
Registered queue worker handler, usually a defineWorkflowJob().
runIdRequired
string
Checkpoint run, 1 to 256 characters and not blank. Jobs with the same runId and input share one checkpoint; a different input makes it incompatible.
inputOptional
WorkflowJson | undefined
Lossless JSON input for the workflow; defaults to null.

Signature

export interface TriggerJob {
  /** Registered queue worker handler, usually a `defineWorkflowJob()`. */
  readonly handler: string;
  /** Checkpoint run identifier; events for the same run converge on one checkpoint. */
  readonly runId: string;
  readonly input?: WorkflowJson;
}

WorkflowJson