Skip to content
v9.1.1
Français

QueuedTaskOptions

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

Parameters and properties

Section titled “Parameters and properties”
  • retryOptional
    Retry | undefined
    Retry policy for failed attempts; without it the task runs once. A retried attempt repeats its side effects.
  • cacheOptional
    TaskCacheOptions | undefined
    Result cache: a hit restores the stored lossless JSON value with no attempt, usage or side effects. On a miss, a result that is not lossless JSON fails the task. Rejected on gates, interactions and dispatch-result tasks.
  • gateOptional
    WorkflowGate | undefined
    Persisted approval or pause definition; execution requires a checkpoint and a matching trusted decision.
  • keyRequired
    string
    Unique key in the workflow, matching [A-Za-z0-9][A-Za-z0-9._-]*. Records, events and checkpoints identify the task by it.
  • afterOptional
    readonly Task<unknown>[] | undefined
    Tasks that must be done before this one starts, default none; only these can be read with context.value().
  • interactionOptional
    TaskInteraction | undefined
    Opt-in durable human-input contract; requires checkpointed scheduling and cannot be combined with a gate.
  • conditionOptional
    ((context: TaskContext) => boolean | Promise<boolean>) | undefined
    Evaluated with attempt 0 before the task runs, including when a later start() resumes it; false ends the task as skipped, which skips its dependents.
  • timeoutMsOptional
    number | undefined
    Deadline in milliseconds for each attempt, a positive integer up to 2147483647. Expiry aborts context.signal and fails the attempt, which retry may repeat.
  • queueRequired
    TaskQueue
    Queue in which the task enqueues its job and polls it.
  • handlerRequired
    string
    Name of the worker handler that runs the job, 1 to 512 characters.
  • inputRequired
    (context: TaskContext) => WorkflowJson
    Builds the job’s JSON input from the task context, such as dependency values. Called on each attempt: a different value under the same job ID is rejected.
  • decodeRequired
    (value: WorkflowJson) => T
    Converts the job’s JSON value into the task’s result; throw to fail the task.
  • deadlineOptional
    number | undefined
    Job deadline in epoch milliseconds; the job becomes cancelled once it passes.
  • pollMsOptional
    number | undefined
    Interval between job reads in milliseconds, default 250; must be positive.

Signature

Section titled “Signature”
export type QueuedTaskOptions<T> = Omit<TaskOptions<T>, "perform"> & {
  readonly queue: TaskQueue;
  readonly handler: string;
  readonly input: (context: TaskContext) => WorkflowJson;
  readonly decode: (value: WorkflowJson) => T;
  readonly deadline?: number;
  readonly pollMs?: number;
};
Section titled “Related contracts”