@hlang-org/interpreter

Classes

GraphError

Defined in: packages/ir/lib/index.d.ts:136

Thrown by planGraph when a graph violates hlang's rules.

Extends

• Error

Constructors

Constructor

new GraphError(code, message): GraphError;

Defined in: packages/ir/lib/index.d.ts:138

Parameters

Returns

GraphError

Overrides

Error.constructor

Properties

NodeRegistry

Defined in: packages/interpreter/src/registry.ts:23

A mutable node registry.

Implements

• INodeRegistry

Constructors

Constructor

new NodeRegistry(): NodeRegistry;

Returns

NodeRegistry

Methods

codes()

codes(): readonly string[];

Defined in: packages/interpreter/src/registry.ts:43

All registered codes, in insertion order.

Returns

readonly string[]

Implementation of

INodeRegistry.codes

get()

get(code): NodeConstructor | undefined;

Defined in: packages/interpreter/src/registry.ts:35

Return the constructor registered for code, or undefined.

Parameters

Returns

NodeConstructor | undefined

Implementation of

INodeRegistry.get

has()

has(code): boolean;

Defined in: packages/interpreter/src/registry.ts:39

Whether a constructor is registered for code.

Parameters

Returns

boolean

Implementation of

INodeRegistry.has

register()

register(code, ctor): this;

Defined in: packages/interpreter/src/registry.ts:30

Register a node class under code. Re-registering the same code replaces the previous entry (last write wins), which keeps hot-reloading simple.

Parameters

Returns

this

Interfaces

ExecutionPlan

Defined in: packages/ir/lib/index.d.ts:125

A validated, backend-neutral program.

Properties

IBizData

Defined in: packages/ir/lib/index.d.ts:26

Business data attached to a node; params is the user-facing config.

Indexable

[key: string]: unknown

Properties

IConnection

Defined in: packages/ir/lib/index.d.ts:53

A single connection. Direction is inverted from intuition and MUST be preserved: Output is the upstream source (an O port), Input is the downstream target (an I port). Wiring is Output.O(id).connect(Input.I(id)).

Properties

IConnectionEndpoint

Defined in: packages/ir/lib/index.d.ts:33

One endpoint of a connection, as serialized.

Properties

IDisposable

Defined in: packages/interpreter/src/types.ts:14

A cancellable subscription handle.

Extended by

• IExecutionHandle

Methods

dispose()

dispose(): void;

Defined in: packages/interpreter/src/types.ts:15

Returns

void

IExecutionHandle

Defined in: packages/interpreter/src/types.ts:58

A handle to a running interpretation. Lets callers observe node errors and introspect the constructed graph, and tear the run down.

Extends

• IDisposable

Properties

Methods

dispose()

dispose(): void;

Defined in: packages/interpreter/src/types.ts:15

Returns

void

Inherited from

IDisposable.dispose

getNode()

getNode(nodeId): IRuntimeNode | undefined;

Defined in: packages/interpreter/src/types.ts:64

Resolve a constructed node instance by its graph nodeId.

Parameters

Returns

IRuntimeNode | undefined

onActivity()

onActivity(listener): IDisposable;

Defined in: packages/interpreter/src/types.ts:71

Subscribe to output-port emissions across all nodes — the "living stream" signal. Fires each time a node pushes a message on a non-error output port.

Parameters

Returns

IDisposable

onError()

onError(listener): IDisposable;

Defined in: packages/interpreter/src/types.ts:66

Subscribe to errors emitted by any node's @node/error port.

Parameters

Returns

IDisposable

IGraph

Defined in: packages/ir/lib/index.d.ts:88

The complete serialized graph.

Properties

IInterpreterDeps

Defined in: packages/interpreter/src/interpreter.ts:32

Dependencies the interpreter needs, injected for testability.

Properties

IInterpretOptions

Defined in: packages/interpreter/src/types.ts:39

Options controlling interpretation.

Properties

INodeActivityEvent

Defined in: packages/interpreter/src/types.ts:31

A node emitting on one of its output ports during execution — the signal behind the editor's "living stream" visuals. Fires each time a node pushes a message on a non-error output port.

Properties

INodeConstructionOptions

Defined in: packages/interpreter/src/runtime-contract.ts:71

Constructor options passed to every node, mirroring the runtime contract.

Properties

INodeErrorEvent

Defined in: packages/interpreter/src/types.ts:19

An error surfaced from a node's @node/error port during execution.

Properties

INodeInfo

Defined in: packages/ir/lib/index.d.ts:63

A node entry in the graph's node list.

Indexable

[key: string]: unknown

Properties

INodeRegistry

Defined in: packages/interpreter/src/registry.ts:13

Read-only view of a node registry used during interpretation.

Methods

codes()

codes(): readonly string[];

Defined in: packages/interpreter/src/registry.ts:19

All registered codes, in insertion order.

Returns

readonly string[]

get()

get(code): NodeConstructor | undefined;

Defined in: packages/interpreter/src/registry.ts:15

Return the constructor registered for code, or undefined.

Parameters

Returns

NodeConstructor | undefined

has()

has(code): boolean;

Defined in: packages/interpreter/src/registry.ts:17

Whether a constructor is registered for code.

Parameters

Returns

boolean

IPackageInfo

Defined in: packages/ir/lib/index.d.ts:82

A dependency descriptor (populated by the compiler; optional for interpret).

Properties

IPortInfo

Defined in: packages/ir/lib/index.d.ts:58

Port metadata carried on a node (the design-time port descriptors).

Properties

IRuntimeFlow

Defined in: packages/interpreter/src/runtime-contract.ts:89

A runtime Flow. run must be called with a Readable (R) root node.

Methods

run()

run(rootNode): void;

Defined in: packages/interpreter/src/runtime-contract.ts:90

Parameters

Returns

void

IRuntimeNode

Defined in: packages/interpreter/src/runtime-contract.ts:44

A runtime node instance (R, T, or W). Nodes expose I(name) / O(name) accessors that resolve a previously attached port by name.

Properties

Methods

E()

E(): IRuntimePort;

Defined in: packages/interpreter/src/runtime-contract.ts:53

Resolve the error Output port (@node/error). Present on R and T only.

Returns

IRuntimePort

I()

I(name): IRuntimePort;

Defined in: packages/interpreter/src/runtime-contract.ts:49

Resolve an Input port by name.

Parameters

Returns

IRuntimePort

O()

O(name): IRuntimePort;

Defined in: packages/interpreter/src/runtime-contract.ts:51

Resolve an Output port by name.

Parameters

Returns

IRuntimePort

IRuntimePort

Defined in: packages/interpreter/src/runtime-contract.ts:26

A runtime port. Ports are RxJS Subjects under the hood: send is next, receive is subscribe. We only depend on the wiring + messaging surface.

Properties

Methods

connect()

connect(port): IRuntimePort;

Defined in: packages/interpreter/src/runtime-contract.ts:37

Wire this Output port to a downstream Input port. Throws unless O -> I.

Parameters

Returns

IRuntimePort

receive()

receive(next): unknown;

Defined in: packages/interpreter/src/runtime-contract.ts:35

Subscribe to messages on this port (RxJS subscribe). The returned value is an RxJS Subscription; we treat it opaquely.

Parameters

Returns

unknown

send()

send(msg): void;

Defined in: packages/interpreter/src/runtime-contract.ts:30

Push a message downstream (RxJS next).

Parameters

Returns

void

PlannedConnection

Defined in: packages/ir/lib/index.d.ts:120

source is an output (O) port; target is an input (I) port.

Properties

PlannedEndpoint

Defined in: packages/ir/lib/index.d.ts:115

One end of a planned connection.

Properties

PlannedNode

Defined in: packages/ir/lib/index.d.ts:108

A node to construct. config is passed to the node constructor.

Properties

Type Aliases

FlowFactory

type FlowFactory = () => IRuntimeFlow;

Defined in: packages/interpreter/src/runtime-contract.ts:94

Factory that produces a fresh Flow instance.

Returns

IRuntimeFlow

GraphErrorCode

type GraphErrorCode = 
  | "duplicate-node-id"
  | "invalid-node-kind"
  | "unknown-node"
  | "invalid-connection"
  | "no-readable-root";

Defined in: packages/ir/lib/index.d.ts:134

Machine-readable reasons a graph cannot be planned.

NodeConstructor

type NodeConstructor = new (opts) => IRuntimeNode;

Defined in: packages/interpreter/src/runtime-contract.ts:86

A node class constructor. The registry maps an hlang code to one of these. Concrete node classes extend the runtime's ReadableNode / TransformNode / WritableNode.

Parameters

Returns

IRuntimeNode

NodeKind

type NodeKind = "R" | "T" | "W";

Defined in: packages/ir/lib/index.d.ts:11

The three hlang node kinds: Readable (source), Transform, Writable (sink).

ParamBag

type ParamBag = Readonly<Record<string, ParamValue>>;

Defined in: packages/ir/lib/index.d.ts:24

A bag of node parameters (the params object under bizData).

ParamValue

type ParamValue = 
  | string
  | number
  | boolean
  | null
  | readonly ParamValue[]
  | IParamObject;

Defined in: packages/ir/lib/index.d.ts:15

Serialized parameter values carried in bizData.params.

StreamType

type StreamType = "I" | "O";

Defined in: packages/interpreter/src/runtime-contract.ts:20

Stream direction of a port. Mirrors runtime STREAM_TYPE.

Variables

ERROR_PORT_NAME

const ERROR_PORT_NAME: "@node/error" = "@node/error";

Defined in: packages/ir/lib/index.d.ts:13

The output port every Readable and Transform node exposes for errors.

Functions

interpret()

function interpret(
   graph, 
   deps, 
   options?
): IExecutionHandle;

Defined in: packages/interpreter/src/interpreter.ts:53

Interpret and run a graph. Returns a handle to the running flow.

Parameters

Returns

IExecutionHandle

Throws

if the graph has no Readable (R) node, or references a code that is not registered in the supplied registry.

planGraph()

function planGraph(graph): ExecutionPlan;

Defined in: packages/ir/lib/index.d.ts:141

Validate graph and lower it to an ExecutionPlan.

Parameters

Returns

ExecutionPlan