Skip to content
@tde.io/plexis  ·  npm install @tde.io/plexis  ·  npm  ·  GitHub

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.

SectionWhat it covers
Definition FunctionsdefineDomain, definePipeline, MergeMetadata
Registration Helperswhen, enter, exit, on, node, action, fork, terminal
Handler Input TypesGuardInput, ActionInput, PhaseHookInput, PipelineConditionInput
TracercreateTracer, TracerOptions, Tracer methods
Domain InstanceDomain properties and methods, DomainGraph query API
Pipeline InstancePipeline properties and methods, PipelineGraph query API, PathQueryOptions
ErrorsPlexisError and error codes
Key TypesDomainFollowResult, PipelineRunResult, DomainSnapshot, DomainHistoryEntry, NodeInspection, GraphDescriptor, PatchLike, ErrorPolicy, TraceEvent, TraceLevel, TraceStatus