@svatah/yam-conformance
Surface and runtime conformance suites
- Source:
packages/conformance· README:packages/conformance/README.md - Install:
npm install @svatah/yam-conformance - Version 0.1.0 · Apache-2.0
Exports
| Export | Kind | Signature | |
|---|---|---|---|
BridgeCost | interface | export interface BridgeCost | What the adapter's bridge cost, when it has one (Draft 2.8 §7.5). |
CaseContext | interface | export interface CaseContext | What a case is handed. |
CaseReport | interface | export interface CaseReport | |
CheckResult | interface | export interface CheckResult | One observation the suite made. |
ConformanceCase | interface | export interface ConformanceCase | |
ConformanceReport | interface | export interface ConformanceReport | |
DESKTOP_CASES | variable | DESKTOP_CASES: readonly ConformanceCase[] = [ | |
DESKTOP_HEALING_CASES | variable | DESKTOP_HEALING_CASES: readonly ConformanceCase[] = [ | |
DesktopHealing | interface | export interface DesktopHealing | |
HealCandidate | interface | export interface HealCandidate | A relocalization candidate as a report shows it: what it is, and its scores. |
HealOutcome | interface | export interface HealOutcome | What model-free relocalization answered (LLD §6.4). |
RecordedElement | interface | export interface RecordedElement | What the desktop healing cases need, and this package will not import |
renderMarkdown | function | export function renderMarkdown(report: ConformanceReport): string | A Markdown report, for the release notes (REQ-PKG-4). |
renderReport | function | export function renderReport(report: ConformanceReport): string | A plain-text report for a terminal. |
RunOptions | interface | export interface RunOptions | |
runSurfaceConformance | function | export async function runSurfaceConformance(options: RunOptions): Promise<ConformanceReport> | Run the suite against one adapter (REQ-SURF-3, REQ-STD-2). |
SURFACE_CASES | variable | SURFACE_CASES: readonly ConformanceCase[] = [ |