Reference
API reference
Generated public modules and their exported types, functions, errors, and services.
The API reference is generated from the public TypeScript entry points and their TSDoc comments on every docs build. It mirrors the package's supported import structure.
- Machine describes definitions, nodes, transitions, codecs, definition-owned execution, handles, and inspection types.
- MachineEngine describes engine configuration, persistent store composition, and the explicit memory Layer.
- MachineStore describes aggregate identities and Schemas, the atomic adapter contract, compare-and-set results, and the memory store.
- LocalStorageMachineStore describes coordinated and explicitly single-context browser persistence.
- MachineWorkflow describes the optional Effect Workflow integration for machine-owned work.
- Graph describes renderer-independent definition projection and activity overlays.
- Mermaid describes Mermaid rendering.
- SourceLocation describes stack-frame parsing, source mapping, and editor links.
The generated pages are information-oriented reference. For a goal-oriented integration path, use Run machine work through Effect Workflow.