Graph

Graph: object

Defined in: Core/Graph.ts:25

Runs asynchronous tasks after their dependencies succeed.

Shared dependencies run once per execution. Independent nodes can run concurrently, and failures signal active tasks to stop.

Type Declaration

make

make: <Id, E, Out, Input>(target, options?) => Graph<E, Out, Input> = makeGraph

Builds a reusable execution plan for a target node and its dependencies.

Checks for duplicate node IDs and cycles when called. Invalid graphs throw an error.

Type Parameters

Id

Id extends string

E

E

Out

Out

Input

Input

Parameters

target

WithKind<"GraphNode"> & object & (unknown extends Input ? never : unknown)

options?

MakeOptions

Returns

Graph<E, Out, Input>

See

• Graph.node for defining upstream DAG nodes.
• Graph.run for executing compiled graphs.

Example

const dashboardGraph = Graph.make(summaryNode);

node

node: {<Id, Input, E, Out>(id, run): Node<Id, E, Out, unknown extends Input ? void : Input>; <Id, Deps, Input, E, Out>(id, deps, run): Node<Id, E | NodeErrorOf<Deps[keyof Deps]>, Out, NodeInput<Deps, Input>>; } = makeNode

Call Signature

<Id, Input, E, Out>(id, run): Node<Id, E, Out, unknown extends Input ? void : Input>

Creates an individual node descriptor for inclusion in a DAG.

Dependencies are declared as an object dictionary of upstream nodes. The run callback receives the per-run input in ctx and dependency outputs in deps.

Type Parameters

Id

Id extends string

Input

Input = unknown

E

E = never

Out

Out = never

Parameters

id

Id

run

NodeRun<undefined, Input, E, Out>

Returns

Node<Id, E, Out, unknown extends Input ? void : Input>

See

• Graph.make to compile declared nodes into a validated execution graph.
• Graph.run for executing compiled graphs.

Example

const user = Graph.node("user", () => fetchUser("u_1"));

const permissions = Graph.node("permissions", { user }, ({ deps }) =>
  fetchPermissions(deps.user.roleId));

Call Signature

<Id, Deps, Input, E, Out>(id, deps, run): Node<Id, E | NodeErrorOf<Deps[keyof Deps]>, Out, NodeInput<Deps, Input>>

Creates an individual node descriptor for inclusion in a DAG.

Dependencies are declared as an object dictionary of upstream nodes. The run callback receives the per-run input in ctx and dependency outputs in deps.

Type Parameters

Id

Id extends string

Deps

Deps extends Record<string, AnyNode<never>>

Input

Input = unknown

E

E = never

Out

Out = never

Parameters

id

Id

deps

Deps

run

NodeRun<Deps, Input, E, Out>

Returns

Node<Id, E | NodeErrorOf<Deps[keyof Deps]>, Out, NodeInput<Deps, Input>>

See

• Graph.make to compile declared nodes into a validated execution graph.
• Graph.run for executing compiled graphs.

Example

const user = Graph.node("user", () => fetchUser("u_1"));

const permissions = Graph.node("permissions", { user }, ({ deps }) =>
  fetchPermissions(deps.user.roleId));

nodeFactory

nodeFactory: <Input>() => NodeFactory<Input>

Creates a node constructor with a shared input type.

Type Parameters

Input

Input

Returns

NodeFactory<Input>

Example

const node = Graph.nodeFactory<ReportInput>();
const customer = node("customer", ({ ctx }) => findCustomer(ctx.input.id));

run

run: {(): <E, Out>(graph) => Deferred<Result<Aborted | E, Out>>; <Input>(input, options?): <E, Out>(graph) => Deferred<Result<Aborted | E, Out>>; } = runGraph

Call Signature

(): <E, Out>(graph) => Deferred<Result<Aborted | E, Out>>

Starts a compiled graph and returns a deferred result.

Runs independent nodes concurrently, subject to the configured limit, and runs each shared dependency once per graph execution. If a node returns an error, the graph settles with that error and signals active tasks to abort. Tasks must respond to the signal to stop their work. A caller’s abort signal settles the graph with Aborted even if active tasks ignore it.

Returns

<E, Out>(graph) => Deferred<Result<Aborted | E, Out>>

See

• Graph.make to compile a target node into a validated graph.
• Graph.node for defining upstream DAG nodes.

A graph with no input is run as Graph.run()(graph). Pass undefined as the input when such a graph also needs run options: Graph.run(undefined, { signal })(graph).

Example

const outcome = await Graph.run(reportInput)(dashboardGraph);

Call Signature

<Input>(input, options?): <E, Out>(graph) => Deferred<Result<Aborted | E, Out>>

Starts a compiled graph and returns a deferred result.

Runs independent nodes concurrently, subject to the configured limit, and runs each shared dependency once per graph execution. If a node returns an error, the graph settles with that error and signals active tasks to abort. Tasks must respond to the signal to stop their work. A caller’s abort signal settles the graph with Aborted even if active tasks ignore it.

Type Parameters

Input

Input

Parameters

input

Input

options?

RunOptions

Returns

<E, Out>(graph) => Deferred<Result<Aborted | E, Out>>

See

• Graph.make to compile a target node into a validated graph.
• Graph.node for defining upstream DAG nodes.

A graph with no input is run as Graph.run()(graph). Pass undefined as the input when such a graph also needs run options: Graph.run(undefined, { signal })(graph).

Example

const outcome = await Graph.run(reportInput)(dashboardGraph);