Interface: StepMockApi
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:57
Seeding and assertion surface exposed as harness.steps.
Methods
clearMocks()
clearMocks():
void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:85
Drop every seed, including skipSleeps(). Recorded rows are untouched.
Returns
void
error()
error(
stepId):Promise<string|undefined>
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:98
Recorded error message of stepId, when it failed.
Parameters
stepId
string
Returns
Promise<string | undefined>
mockError()
mockError(
stepId,error,opts?):void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:72
The next claim of stepId records a failed step, so the step throws the
stored error instead of running its body.
Recorded at MOCKED_FAILURE_ATTEMPT so the step's own retries
do not re-enter the real body. Pass { attempt } to seed a lower one
when the retry path is what you are testing.
Parameters
stepId
string
error
unknown
opts?
attempt?
number
Returns
void
mockResult()
mockResult(
stepId,result):void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:63
The next claim of stepId records a completed step with this result,
without running its body. Applies to step.run, step.waitFor and
step.waitForSignal.
Parameters
stepId
string
result
unknown
Returns
void
mockTimeout()
mockTimeout(
stepId):void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:79
The next claim of stepId records a wait whose deadline has already
passed, so the step fails with StepTimeoutError through the engine's
own timeout path. Only step.waitFor and step.waitForSignal have a
deadline; mocking any other kind this way throws.
Parameters
stepId
string
Returns
void
record()
record(
stepId):Promise<StepRecord|null>
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:90
The recorded row for stepId, or null when the step never ran.
Parameters
stepId
string
Returns
Promise<StepRecord | null>
records()
records():
Promise<StepRecord[]>
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:92
Every row this ledger holds, in (stage, seq) order.
Returns
Promise<StepRecord[]>
result()
result<
T>(stepId):Promise<T|undefined>
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:96
Recorded result of stepId. Undefined when the step never ran.
Type Parameters
T
T = unknown
Parameters
stepId
string
Returns
Promise<T | undefined>
skipSleep()
skipSleep(
stepId):void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:81
step.sleep(stepId, …) returns immediately instead of suspending.
Parameters
stepId
string
Returns
void
skipSleeps()
skipSleeps():
void
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:83
Every step.sleep returns immediately instead of suspending.
Returns
void
status()
status(
stepId):Promise<"failed"|"pending"|"completed"|"running"|undefined>
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:94
Recorded status of stepId, or undefined when the step never ran.
Parameters
stepId
string
Returns
Promise<"failed" | "pending" | "completed" | "running" | undefined>
wasMocked()
wasMocked(
stepId):boolean
Defined in: packages/workflow-engine/src/testing/mock-step-ledger.ts:87
True once a seed has decided stepId's recorded outcome.
Parameters
stepId
string
Returns
boolean