Skip to content
1 min read · 171 words

Function: runVectorStoreConformance() ​

ts
function runVectorStoreConformance(
  label: string,
  makeStore: () => Promise<CallableVectorStore>,
  dim?: number,
  opts?: {
    retry?: number;
    timeout?: number;
  },
): Promise<void>;

Defined in: src/batteries/vector/conformance/index.ts:118

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

Each check creates a fresh store through makeStore; the returned promise rejects when any contract assertion fails. Consumers can await this function from any test runner without importing a test framework from the conformance module.

Parameters ​

ParameterTypeDefault valueDescription
labelstringundefinedHuman-readable name used to identify the implementation under test.
makeStore() => Promise<CallableVectorStore>undefinedFactory returning a fresh, connected store with the docs collection.
dimnumber3Vector dimensionality used by the suite (defaults to 3).
opts{ retry?: number; timeout?: number; }{}Retry count and per-attempt timeout in milliseconds for eventually consistent stores.
opts.retry?numberundefined-
opts.timeout?numberundefined-

Returns ​

Promise<void>