Class TestEngine

engine

advance

• advance(by: Duration): Promise<void>

  Moves the clock forward: timers that fall due fire.

  Parameters

  • by: Duration

  Returns Promise<void>

check

• check(): Promise<void>

  Strict replay of every run against the registered code: throws DeterminismError naming each run and step whose code differs from its journal.

  Returns Promise<void>

close

• close(): Promise<void>

  Returns Promise<void>

crash

• crash(opts?: { cut?: { beforeStep: number; id: string } }): Promise<void>

  Drops the engine's memory as a crash would and recovers: a new engine loads every run from its journal, the code replays, and runs continue. Recorded steps do not run again.

  Parameters

  • opts: { cut?: { beforeStep: number; id: string } } = {}

  Returns Promise<void>

mockStep

• mockStep(
      wf: string | WorkflowDefinition<any, any>,
      step: string,
      fn: Mock,
  ): void

  Replaces a step's function: fn(attempt) returns its result, or throws to fail that attempt.

  Parameters

  • wf: string | WorkflowDefinition<any, any>
  • step: string
  • fn: Mock

  Returns void

now

• now(): number

  The virtual time, Unix ms.

  Returns number

result

• result<O = unknown>(id: string): Promise<O>

  The run's result. While every run waits on a timer, time skips to it, so a workflow that sleeps a day finishes at once.

  Type Parameters

  • O = unknown

  Parameters

  • id: string

  Returns Promise<O>

run

• run<O = unknown>(id: string): Run<O>

  Type Parameters

  • O = unknown

  Parameters

  • id: string

  Returns Run<O>

snapshot

• snapshot(id: string): Promise<JournalRecord[]>

  The run's journal without times or run IDs, for snapshot tests.

  Parameters

  • id: string

  Returns Promise<JournalRecord[]>

start

• start<I, O>(
      wf: string | WorkflowDefinition<I, O>,
      id: string,
      input: I,
      opts?: StartOptions,
  ): Promise<Run<O>>

  Type Parameters

  • I
  • O

  Parameters

  • wf: string | WorkflowDefinition<I, O>
  • id: string
  • input: I
  • opts: StartOptions = {}

  Returns Promise<Run<O>>

steps

• steps(id: string): Promise<string[]>

  The names of the steps the run recorded, in order.

  Parameters

  • id: string

  Returns Promise<string[]>

Staticopen

• open(
      opts?: {
          shards?: number;
          workflows?: readonly WorkflowDefinition<any, any>[];
      },
  ): Promise<TestEngine>

  Parameters

  • opts: { shards?: number; workflows?: readonly WorkflowDefinition<any, any>[] } = {}

  Returns Promise<TestEngine>