Skip to content
v9.1.1
Français

ArtifactTaskOptions

import type { ArtifactTaskOptions } 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.
  • storeRequired
    ArtifactStore
    Store that receives the published artifact.
  • contractRequired
    ArtifactContract<T>
    Contract that validates and encodes the produced value.
  • produceRequired
    (context: TaskContext) => T | Promise<T>
    Compute the value to publish from the task context, for example from context.value() of a dependency.
  • parentsOptional
    ((context: TaskContext) => readonly ArtifactReference[]) | undefined
    Return the parent references to record, usually context.value() of artifact tasks listed in after. Runs before produce().

Signature

Section titled “Signature”
export type ArtifactTaskOptions<T> = Omit<
  TaskOptions<ArtifactReference>,
  "perform"
> & {
  readonly store: ArtifactStore;
  readonly contract: ArtifactContract<T>;
  readonly produce: (context: TaskContext) => T | Promise<T>;
  readonly parents?: (context: TaskContext) => readonly ArtifactReference[];
};
Section titled “Related contracts”