WorkflowNode

CORE · type · Type contract

One node of the graph.

Import

TypeScript

import type { WorkflowNode } from '@jangts/agent-core/engine';

JavaScript

/** @typedef {import('@jangts/agent-core/engine').WorkflowNode} WorkflowNode */

Other public entry points:@jangts/agent-core, @jangts/agent-core/engine, @jangts/agent-core/types, @jangts/agent-core/structs.

Definition

Type: WorkflowNode<State, Result, Runtime>

Type parameters

Type parameter	Constraint	Default type
State	—	—
Result	—	—
Runtime	—	undefined

Field structure

Field	Type	Required	Description
id	string	Required	Read-only. Stable node id referenced by routes and error handling.
description	string	Required	Read-only. Required explanation of what the node does; also used in diagnostics.
name	string | undefined	Optional	Read-only. Display name; defaults to id when omitted.
report	((update: Readonly<Partial<State>> | void, context: NodeReportingContext) => WorkflowNodeReport) | undefined	Optional	Read-only. Optional application-reported detail, collected only when content logging is enabled.
startsRound	boolean | undefined	Optional	Read-only. Reserves a fresh round on entry. Use it for steps that may legitimately repeat; entering such a node when the round budget is exhausted fails with the configured exhausted error.
onErrorNodeId	string | undefined	Optional	Read-only. Node entered when run/provides/route fails; contract errors always propagate instead.
onErrorRouteId	string | undefined	Optional	Read-only. Route id reported with the recovery transition.
requires	readonly (keyof State & string)[] | undefined	Optional	Read-only. State keys that must be present before this node runs; enforced by the engine.
provides	readonly (keyof State & string)[] | undefined	Optional	Read-only. State keys this node is expected to produce; validated after run.
routes	readonly WorkflowRoute<State, Result, Runtime>[]	Required	Read-only. Candidate successors, evaluated in order. A getter must be pure; registration reads it once.
run	((state: Readonly<State>, context: WorkflowContext<Runtime>) => void | Partial<State> | Promise<void | Partial<State>>) | undefined	Optional	Read-only. Return only changed fields. Core commits them after cancellation and output checks.

Examples

• Workflow: nodes, routes, and partial state updates: Use a single node definition that actually participates in execution to show order, branches, error destinations, and end conditions together.

A single node completes the greeting

Beginner · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';

type State = { name: string; answer?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [{
    id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
    run: state => ({ answer: '你好，' + state.name }),
    routes: [route.deliver('answer')],
  }],
});
console.log(workflow.entryNodeId);
console.log(workflow.describe());

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [{
            id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
            run: state => ({ answer: '你好，' + state.name }),
            routes: [route.deliver('answer')],
        }],
});
console.log(workflow.entryNodeId);
console.log(workflow.describe());

Add a validation stage without changing state or the run call

Configuration · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
type State = { name: string; answer?: string; error?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [
    { id: 'check', description: '检查姓名', startsRound: true,
      run: state => ({ error: state.name.trim() ? undefined : '姓名不能为空' }),
      routes: [route.toIfError('failure'), route.to('greet')] },
    { id: 'greet', description: '生成问候', provides: ['answer'],
      run: state => ({ answer: '你好，' + state.name }), routes: [route.deliver('answer')] },
    { id: 'failure', description: '返回校验提示', requires: ['error'], routes: [route.deliver('error')] },
  ],
});
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [
        { id: 'check', description: '检查姓名', startsRound: true,
            run: state => ({ error: state.name.trim() ? undefined : '姓名不能为空' }),
            routes: [route.toIfError('failure'), route.to('greet')] },
        { id: 'greet', description: '生成问候', provides: ['answer'],
            run: state => ({ answer: '你好，' + state.name }), routes: [route.deliver('answer')] },
        { id: 'failure', description: '返回校验提示', requires: ['error'], routes: [route.deliver('error')] },
    ],
});
console.log(await new AgentCoreEngine({ workflow }).run({ name: 'Ivan' }));

Related policy source

• Reference, reachability, and bounded-loop validation

Related definitions

• NodeReportingContext
• WorkflowContext
• WorkflowNodeReport
• WorkflowRoute