Class StepCtx

What a step's function gets when it declares a parameter: ctx.step("charge", (s) => pay({ idempotencyKey: s.key, signal: s.signal })).

Index

Properties

Accessors

key signal workflowId

Methods

heartbeat progress stream

Properties

`Readonly`attempt

attempt: number

1 on the first attempt, then 2, 3, ...

`Readonly`name

name: string

The step's name.

Accessors

key

get key(): string

A key stable across retries and recovery, distinct for each step of each run: pass it to services that accept idempotency keys.

Returns string

signal

get signal(): AbortSignal

Aborted when this attempt times out (or misses its heartbeat), or the run is cancelled, terminated or closed. Pass it to fetch and the like.

Returns AbortSignal

workflowId

get workflowId(): string

Returns string

Methods

heartbeat

heartbeat<T>(progress?: T): void
Reports progress; resets the heartbeat timeout. Coalesced; never waits for the disk.
Type Parameters
- T
Parameters
- Optionalprogress: T
Returns void

progress

progress<T>(): T | undefined
The latest progress this step reported, also from an attempt before a crash.
Type Parameters
- T
Returns T | undefined

stream

stream(name: string): StreamWriter
Opens this step's stream name (see ctx.stream).
Parameters
- name: string
Returns StreamWriter