Skip to content

rulvar API reference


rulvar API reference / @rulvar/store-conformance / ConformanceSuite

Interface: ConformanceSuite

Defined in: packages/store-conformance/src/types.ts:14

@rulvar/store-conformance: the executable store conformance kit (M2-T11, DEF-4). A store implementation passes journalStoreConformance (and leasableStoreConformance when it has the lease capability) or it is not a rulvar store; the kit is the executable definition of the storage seam frozen at 1.0.

Usage under Vitest:

const suite = journalStoreConformance(() => new MyStore()); registerConformance(suite, { describe, it });

Public docs: https://docs.rulvar.com/guide/stores (conformance obligations) and https://docs.rulvar.com/guide/testing (conformance tier).

Properties

PropertyTypeDefined in
checksreadonly ConformanceCheck[]packages/store-conformance/src/types.ts:16
namestringpackages/store-conformance/src/types.ts:15

Methods

run()

ts
run(): Promise<void>;

Defined in: packages/store-conformance/src/types.ts:18

Runs every check sequentially; throws on the first violation.

Returns

Promise&lt;void&gt;