uni-flow 公开 API（中文注解）

---

uni-flow 公开 API（中文注解） / DefaultWorkflowEngine

Class: DefaultWorkflowEngine

Defined in: core/workflow-engine.ts:60

默认工作流引擎实现：按 ControlFlow 调度 Unit，串联 Layer4（策略、上下文、检查点、安全、可观测性）。 一般通过 createWorkflowEngine 或 createEngineFromYaml 获取，无需直接 new。

Implements

• WorkflowEngine

Constructors

Constructor

new DefaultWorkflowEngine(config, options?): DefaultWorkflowEngine

Defined in: core/workflow-engine.ts:82

Parameters

config

WorkflowConfig

工作流配置（units、controlFlow、可选 sharedState / messageBus）

options?

WorkflowEngineOptions = {}

Layer4 依赖与策略覆盖

Returns

DefaultWorkflowEngine

Methods

followUp()

followUp(targetUnitId, content): void

Defined in: core/workflow-engine.ts:170

向目标 Unit 发送 follow-up 内容（追加指令）。

Parameters

targetUnitId

string

目标 Unit ID

content

string

follow-up 文本

Returns

void

Implementation of

WorkflowEngine.followUp

---

getMessages()

getMessages(): WorkflowMessage[]

Defined in: core/workflow-engine.ts:218

获取 MessageBus 历史消息快照。

Returns

WorkflowMessage[]

已发布的工作流消息列表

Implementation of

WorkflowEngine.getMessages

---

getRunId()

getRunId(): string

Defined in: core/workflow-engine.ts:227

获取当前运行的 runId。

Returns

string

运行 ID 字符串

Implementation of

WorkflowEngine.getRunId

---

getState()

getState(): SharedState

Defined in: core/workflow-engine.ts:209

获取当前 SharedState 句柄（可读写运行时状态）。

Returns

SharedState

共享状态实例

Implementation of

WorkflowEngine.getState

---

respondToHITL()

respondToHITL(approved, responder): Promise<void>

Defined in: core/workflow-engine.ts:187

响应人工确认（HITL）：批准或拒绝后解除暂停，继续调度。

Parameters

approved

boolean

是否批准

responder

string

操作者标识（写入状态供审计）

Returns

Promise<void>

Implementation of

WorkflowEngine.respondToHITL

---

resume()

resume(runId, snapshotId?): Promise<WorkflowResult>

Defined in: core/workflow-engine.ts:121

从检查点恢复指定 runId 的运行（可选指定 snapshotId）。

Parameters

runId

string

先前运行的 ID

snapshotId?

string

可选快照 ID；省略则由存储选择最新/默认

Returns

Promise<WorkflowResult>

恢复后继续执行得到的结果

Throws

找不到检查点时抛出错误

Implementation of

WorkflowEngine.resume

---

run()

run(input?): Promise<WorkflowResult>

Defined in: core/workflow-engine.ts:104

启动一次新运行：将 input 写入 SharedState 后进入调度循环。

Parameters

input?

Record<string, unknown>

初始状态键值（常见：task、context、params）

Returns

Promise<WorkflowResult>

运行结果（runId、completedUnits、state 快照等）

Implementation of

WorkflowEngine.run

---

steer()

steer(targetUnitId, content): void

Defined in: core/workflow-engine.ts:153

向正在执行的目标 Unit 注入 steering 内容（运行时纠偏）。

Parameters

targetUnitId

string

目标 Unit ID

content

string

steering 文本

Returns

void

Implementation of

WorkflowEngine.steer