Skip to content
1 min read · 114 words

Function: runPlanStoreConformance() ​

ts
function runPlanStoreConformance(
  label: string,
  makeStore: () => PlanStore | Promise<PlanStore>,
): Promise<void>;

Defined in: src/batteries/orchestration/conformance.ts:93

Run the framework-free PlanStore conformance suite against a consumer implementation.

Each check creates a fresh store through makeStore, and the returned promise rejects when any contract assertion fails. Consumers can await this function from Vitest, node:test, Jest, Mocha, or another runner without importing a test framework from the conformance module.

Parameters ​

ParameterTypeDescription
labelstringHuman-readable name used to identify the implementation under test.
makeStore() => | PlanStore | Promise<PlanStore>Factory returning a fresh PlanStore for each conformance check; it may be async.

Returns ​

Promise<void>