Interface: CreateStepApiOptions

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:47

Properties

abortSignal?

optional abortSignal?: AbortSignal

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:69

The stage invocation's abort signal (ctx.abortSignal), handed to every run body as step.abortSignal and checked by waitFor before it polls. Defaults to a signal that never fires.

---

ai?

optional ai?: () => AIHelper

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:71

Lazy accessor for the stage's AI helper, used by step.ai.*.

Returns

AIHelper

---

clock

clock: Clock

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:50

---

defaultLeaseMs?

optional defaultLeaseMs?: number

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:63

Default lease for run() calls. Defaults to five minutes.

---

onAnnotate?

optional onAnnotate?: (key, value, opts) => void

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:57

Records a ledger-integrity finding on the run itself, so it survives the log stream. Optional: a caller with no annotation sink still gets the WARN.

Parameters

key

string

value

string

opts

idempotencyKey

string

payload

Record<string, unknown>

Returns

void

---

onLog?

optional onLog?: (level, message) => void

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:51

Parameters

level

"DEBUG" | "WARN"

message

string

Returns

void

---

random?

optional random?: () => number

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:76

Uniform source in [0, 1) for retryBackoff.jitter. Defaults to Math.random; injectable so a test can pin the drawn delay.

Returns

number

---

stageRecordId?

optional stageRecordId?: string

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:48

---

stepLedger?

optional stepLedger?: StepLedger

Defined in: packages/workflow-engine/src/kernel/helpers/step-api.ts:49