Skip to main content

Interface: CreateTestKernelOptions<TEventSink>

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:38

Type Parameters​

TEventSink​

TEventSink extends EventSink = CollectingEventSink

Properties​

blobStore?​

optional blobStore?: InMemoryBlobStore

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:87

Blob store. Defaults to a fresh InMemoryBlobStore.

clock?​

optional clock?: FakeClock

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:63

A pre-built FakeClock to use verbatim, taking precedence over clockStart. For tests that need to hold a FakeClock reference before the kernel is constructed (e.g. a stage closure that calls clock.advance() during execution). Typed as the concrete class (not the Clock port) so opts.clock ?? new FakeClock(...) doesn't widen the returned clock field back down to the port interface.

clockStart?​

optional clockStart?: Date

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:54

Starting time for the FakeClock. Ignored when opts.clock is given. Defaults to FakeClock's own default (a fixed 2025-01-01T00:00:00Z). Pass new Date() for tests (e.g. reap/duration checks) that compare the clock against real new Date() timestamps stamped by InMemoryWorkflowPersistence.

eventSink?​

optional eventSink?: TEventSink

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:75

Full EventSink override, taking precedence over opts.plugins. Use for ad hoc sinks (e.g. one that fails on specific events).

idempotencyStaleInProgressMs?​

optional idempotencyStaleInProgressMs?: number

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:77

Forwarded to createKernel's idempotencyStaleInProgressMs.

pluginMaxRetries?​

optional pluginMaxRetries?: number

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:70

Max retries for the plugin runner. Only used with opts.plugins.

plugins?​

optional plugins?: PluginDefinition<"step:signalled" | "workflow:created" | "workflow:started" | "workflow:completed" | "workflow:failed" | "workflow:cancelled" | "workflow:suspended" | "stage:started" | "stage:completed" | "stage:suspended" | "stage:failed" | "stage:retrying" | "stage:progress" | "annotation:created">[]

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:68

Plugin definitions wired through a createPluginRunner EventSink. Ignored when opts.eventSink is given.

services?​

optional services?: KernelServices

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:89

Optional services exposed lazily through stage contexts.

spillThresholdBytes?​

optional spillThresholdBytes?: number

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:83

Forwarded to createKernel's spillThresholdBytes. Pass a small value to exercise the claim check without building a 64 KiB fixture, or Number.POSITIVE_INFINITY to keep every step result inline.

stepLedger?​

optional stepLedger?: StepLedger

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:85

Optional durable step ledger for stages that use ctx.step.*.

workerId?​

optional workerId?: string

Defined in: packages/workflow-engine/src/testing/create-test-kernel.ts:46

Worker id passed to the underlying InMemoryJobQueue. Defaults to "test-worker", matching every existing fixture -- pass this explicitly at call sites where the test asserts on the literal id.