API Reference
The API reference is organized into per-section pages. Each page documents one group of related symbols with parameters, return values, and inline usage examples.
Reference sections
Section titled “Reference sections”| Section | What it covers |
|---|---|
| Definition Functions | defineDomain, definePipeline, MergeMetadata |
| Registration Helpers | when, enter, exit, on, node, action, fork, terminal |
| Handler Input Types | GuardInput, ActionInput, PhaseHookInput, PipelineConditionInput |
| Tracer | createTracer, TracerOptions, Tracer methods |
| Domain Instance | Domain properties and methods, DomainGraph query API |
| Pipeline Instance | Pipeline properties and methods, PipelineGraph query API, PathQueryOptions |
| Errors | PlexisError and error codes |
| Key Types | DomainFollowResult, PipelineRunResult, DomainSnapshot, DomainHistoryEntry, NodeInspection, GraphDescriptor, PatchLike, ErrorPolicy, TraceEvent, TraceLevel, TraceStatus |
Quick links
Section titled “Quick links”- New to Plexis? Start with the Domain guide and the Pipeline guide.
- Adding observability? See the Tracer guide and the Tracer reference.
- Handling errors? See the Error Handling guide and the Errors reference.