Skip to content

RunObsidianVersionMatrixParams

Parameters for runObsidianVersionMatrix.

Import:

import type { RunObsidianVersionMatrixParams } from 'obsidian-integration-testing';

Signature:

export interface RunObsidianVersionMatrixParams

Properties

PropertyTypeDescription
run(entry: ObsidianVersionMatrixEntry) => Promise<void> | voidRuns the suites against one concrete Obsidian version, throwing on failure.

The entry's version is the concrete x.y.z to pin — typically forwarded to the test-runner child as OBSIDIAN_VERSION.
versions?readonly string[] | string | undefinedThe version specifiers to run against: an array, or a comma-separated string so an env var can be passed straight through.

Each accepts an explicit 'x.y.z', 'public-latest', or 'catalyst-latest'. Defaults to both ends of the supported range (G99) when omitted or empty, and the list is always de-duplicated on the **resolved** version — so when public has caught up to catalyst, the suites run once.

Links to this page: