Skip to main content

Interface: CompatibilityReport

Defined in: packages/core/src/compatibility.types.ts:105

What checkCompatibility returns over a whole set of live routes. Assert on checked before trusting compatible — a run that read no pointers is compatible with everything.

Example​

const report = checkCompatibility(live, registry);
if (report.checked === 0) throw new Error("no live pointers read — this gate checked nothing");
process.exitCode = report.compatible ? 0 : 1;

Properties​

checked​

checked: number

Defined in: packages/core/src/compatibility.types.ts:107

How many live routes were examined — the length of the live array passed in.

compatible​

compatible: boolean

Defined in: packages/core/src/compatibility.types.ts:109

true when incompatible is empty, including when nothing was checked.

incompatible​

incompatible: RouteIncompatibility[]

Defined in: packages/core/src/compatibility.types.ts:111

One entry per route that would not render, in the order the routes were passed in.