JavaScript API

Embed validation, execution, snapshots, Constraints, and rendering in an application.

JavaScript API overview

Embed WorkSpec validation, execution, snapshots, Constraints, rendering, and migration in Node.js applications.

Understand stable, experimental, compatibility, and internal WorkSpec JavaScript API classifications.

Validate a WorkSpec Starting State document or a project with executable sources.

Create one authoritative WorkSpec run with the supported runtime API.

Inspect an existing authoritative run or create a one-call project snapshot.

Run Constraint source against an existing authoritative WorkSpec run.

Render a resolved WorkSpec snapshot or project as deterministic standalone SVG.

Migrate Previous UAW Syntax data to the historical WorkSpec 2.1 shape.

Create asset IDs and resolve State Library visuals with supported JavaScript helpers.

Resolve pure playback state from authored WorkSpec tasks and interactions.

Run supported custom validators with subprocess isolation or in the current process.

Reference for the public TypeScript declarations returned by the WorkSpec JavaScript API.

Experimental Changes source analysis for editors and developer tools.

Generated support classification for every export reachable from the WorkSpec package entrypoint.