flow() API

Flow builder, workflow graph, execution plan, and mermaid APIs.

Most Used

`AxFlow`

Interface for flows that can be tuned, executed, and used in compositions. Provides methods for building and executing complex AI workflows.

Field	Value
Kind	`class`
Form	`AxFlow`
Source	source

Call Shape

TypeScript

m<TNewState>(transform: (_state: TState) => TNewState): AxFlow<IN, OUT, TNodes, TNewState>;

TypeScript

m<TNewState>(transform: (_state: TState) => Promise<TNewState>): AxFlow<IN, OUT, TNodes, TNewState>;

TypeScript

m<TNewState>(transforms: (_state: TState) => TNewState[], options: object): AxFlow<IN, OUT, TNodes, TNewState>;

Full reference

`flow`

Creates a new AxFlow builder. Passing a string compiles a mermaid flowchart in the AxFlow dialect (see AxFlow.toString) into a runnable flow — node contracts come from %%ax nodeId: <signature> directives or from bindings.nodes, data wiring is by field name (a node input binds to the nearest upstream producer of that field), labeled out-edges of a decision node become branches, and back-edges become feedback/while loops. flow(String(otherFlow)) round-trips.

Field	Value
Kind	`variable`
Form	`flow`
Returns	`AxFlow`<`TInput`, `TOutput`, { }, `TInput`>
Source	source

Call Shape

TypeScript

<TInput, TOutput>(options?: AxFlowOptions): AxFlow<TInput, TOutput, {
}, TInput>;

TypeScript

<TInput, TOutput>(mermaid: string, bindings?: AxFlowMermaidBindings): AxFlow<TInput, TOutput, any, any>;

Arguments And Options

Name	Type	Description
`options?`	`AxFlowOptions`

Full reference

Advanced / internals / full reference

`axCreateFlowColorLogger`

Factory function to create a colorized AxFlow logger

Field	Value
Kind	`function`
Form	`axCreateFlowColorLogger`
Returns	`AxFlowLoggerFunction`
Source	source

Call Shape

TypeScript

function axCreateFlowColorLogger(output: (message: string) => void): AxFlowLoggerFunction;

Arguments And Options

Name	Type	Description
`output`	(`message`: `string`) => `void`

Full reference

`axCreateFlowTextLogger`

Factory function to create a text-only AxFlow logger (no colors)

Field	Value
Kind	`function`
Form	`axCreateFlowTextLogger`
Returns	`AxFlowLoggerFunction`
Source	source

Call Shape

TypeScript

function axCreateFlowTextLogger(output: (message: string) => void): AxFlowLoggerFunction;

Arguments And Options

Name	Type	Description
`output`	(`message`: `string`) => `void`

Full reference

`axDefaultFlowLogger`

Default AxFlow logger with colors

Field	Value
Kind	`variable`
Form	`axDefaultFlowLogger`
Source	source

Call Shape

TypeScript

const axDefaultFlowLogger: AxFlowLoggerFunction;

Full reference

`AxFlowable`

Interface for flows that can be tuned, executed, and used in compositions. Provides methods for building and executing complex AI workflows.

Field	Value
Kind	`interface`
Form	`AxFlowable`
Source	source

Call Shape

TypeScript

applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>): void;

Full reference

`AxFlowBranchEvaluationData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowBranchEvaluationData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowCompleteData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowCompleteData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowDynamicContext`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowDynamicContext`
Source	source

Full reference

`AxFlowErrorData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowErrorData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowExecutionPlan`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowExecutionPlan`
Source	source

Full reference

`AxFlowExecutionPlanGroup`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowExecutionPlanGroup`
Source	source

Full reference

`AxFlowExecutionPlanStep`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowExecutionPlanStep`
Source	source

Full reference

`AxFlowForwardOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxFlowForwardOptions`
Source	source

Call Shape

TypeScript

type AxFlowForwardOptions<T> = AxProgramForwardOptionsWithModels<T> & object;

Full reference

`AxFlowLogData`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxFlowLogData`
Source	source

Call Shape

TypeScript

type AxFlowLogData = 
  | AxFlowStartData
  | AxFlowStepStartData
  | AxFlowStepCompleteData
  | AxFlowParallelGroupStartData
  | AxFlowParallelGroupCompleteData
  | AxFlowBranchEvaluationData
  | AxFlowCompleteData
  | AxFlowErrorData;

Full reference

`AxFlowLoggerData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowLoggerData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowLoggerFunction`

Function type for AxFlow logging

Field	Value
Kind	`typealias`
Form	`AxFlowLoggerFunction`
Returns	`void`
Source	source

Call Shape

TypeScript

type AxFlowLoggerFunction = (data: AxFlowLogData) => void;

Arguments And Options

Name	Type	Description
`data`	`AxFlowLogData`

Full reference

`AxFlowMermaidBindings`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowMermaidBindings`
Source	source

Full reference

`AxFlowMermaidError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxFlowMermaidError`
Source	source

Call Shape

TypeScript

new AxFlowMermaidError(
   message: string, 
   line: number, 
   context: string, 
   suggestion?: string): AxFlowMermaidError;

Full reference

`AxFlowMermaidNodeBinding`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxFlowMermaidNodeBinding`
Source	source

Call Shape

TypeScript

type AxFlowMermaidNodeBinding = 
  | string
  | AxSignature
  | {
  forward: (...args: any[]) => any;
}
  | (state: AxFlowState) => 
  | AxFlowState
| Promise<AxFlowState>;

Full reference

`AxFlowMermaidRenderOptions`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowMermaidRenderOptions`
Source	source

Full reference

`AxFlowOptions`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowOptions`
Source	source

Full reference

`AxFlowParallelGroupCompleteData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowParallelGroupCompleteData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowParallelGroupStartData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowParallelGroupStartData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowStartData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowStartData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxFlowState`
Source	source

Call Shape

TypeScript

type AxFlowState = Record<string, unknown>;

Full reference

`AxFlowStateDependencyAnalysis`

Best-effort static dependency extraction for flow execute mappings.

Field	Value
Kind	`interface`
Form	`AxFlowStateDependencyAnalysis`
Source	source

Full reference

`AxFlowStepCompleteData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowStepCompleteData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowStepStartData`

Data types for different AxFlow logging events

Field	Value
Kind	`interface`
Form	`AxFlowStepStartData`
Source	source

Call Shape

TypeScript

[key: string]: unknown

Full reference

`AxFlowTypedParallelBranch`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxFlowTypedParallelBranch`
Returns	`AxFlowTypedSubContext`<`TNodes`, `AxFlowState`>
Source	source

Call Shape

TypeScript

type AxFlowTypedParallelBranch<TNodes, TState> = (subFlow: AxFlowTypedSubContext<TNodes, TState>) => AxFlowTypedSubContext<TNodes, AxFlowState>;

Arguments And Options

Name	Type	Description
`subFlow`	`AxFlowTypedSubContext`<`TNodes`, `TState`>

Full reference

`AxFlowTypedSubContext`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxFlowTypedSubContext`
Source	source

Call Shape

TypeScript

execute<TNodeName, TAI>(
   nodeName: TNodeName, 
   mapping: (state: TState) => GetGenIn<TNodes[TNodeName]>, 
dynamicContext?: AxFlowDynamicContext<TAI>): AxFlowTypedSubContext<TNodes, AddNodeResult<TState, TNodeName, GetGenOut<TNodes[TNodeName]>>>;

Full reference

Full Reference

Open the full TypeScript reference. This page highlights the flow symbols most relevant to everyday use.