Function: runVectorStoreConformance()

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

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

Drive a vector-store adapter through the shared contract suite.

Parameters

Parameter	Type	Default value	Description
label	string	undefined	Human-readable label for the suite (the adapter name).
makeStore	() => Promise<CallableVectorStore>	undefined	Factory returning a fresh, connected store with the 'docs' collection.
dim	number	3	Vector dimensionality the harness pads to (default 3).
opts	{ retry?: number; timeout?: number; }	{}	Per-it retry/timeout overrides.
opts.retry?	number	undefined	-
opts.timeout?	number	undefined	-

Returns

void

Remarks

makeStore must return an already-connected store whose 'docs' collection is created at the matching dimension; it is re-invoked per test so retries are self-contained. dim defaults to 3 — pass a larger value for backends with a dimension floor (the harness pads every test vector to dim). opts.retry / opts.timeout are forwarded to every it() (defaults: retry 0, 5s) and exist for aggressively eventually-consistent managed backends whose read-after-write can flap for seconds — a retried attempt re-runs makeStore() against an index that has had more time to settle, without weakening any assertion.