Uni-Flow

Appearance

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

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

Class: LoopFlow ​

Defined in: core/control-flow/loop-sequential.ts:9

循环 ControlFlow：在达到最大次数或满足终止条件前，反复调度同一个 Unit。

典型场景：重试、迭代 refinement、直到 SharedState 出现某标志为止。 也可由 Workflow YAML 的 flow.type: loop 映射而来。

Implements ​

Constructors ​

Constructor ​

new LoopFlow(unit, maxIterations, terminationCondition?): LoopFlow

Defined in: core/control-flow/loop-sequential.ts:17

Parameters ​

unit ​

WorkflowUnit

每次迭代要执行的 Unit

maxIterations ​

number

最大迭代次数（含首次）；达到后不再调度

terminationCondition? ​

(state) => boolean

可选终止谓词；在第 2 次及之后的 next 中，若返回 true 则停止

Returns ​

LoopFlow

Properties ​

type ​

readonly type: "loop" = 'loop'

Defined in: core/control-flow/loop-sequential.ts:10

Flow 类型名。

Implementation of ​

ControlFlow.type

Methods ​

isComplete() ​

isComplete(state): boolean

Defined in: core/control-flow/loop-sequential.ts:43

Parameters ​

state ​

SharedState

当前 SharedState

Returns ​

boolean

是否已达最大次数，或（至少执行过一次后）终止条件为真

Implementation of ​

ControlFlow.isComplete

next() ​

next(state, _completedUnits?): WorkflowUnit[]

Defined in: core/control-flow/loop-sequential.ts:32

若未达上限且未满足终止条件，返回 [unit]；否则返回空数组。

Parameters ​

state ​

SharedState

当前 SharedState（供终止条件读取）

_completedUnits? ​

Set<string>

引擎侧已完成 Unit 集合（本 Flow 未使用）

Returns ​

WorkflowUnit[]

下一轮要执行的 Unit 列表（0 或 1 个）

Implementation of ​

ControlFlow.next

restore() ​

restore(cursor): void

Defined in: core/control-flow/loop-sequential.ts:58

Parameters ​

cursor ​

ControlFlowCursor

先前 serialize() 的结果

Returns ​

void

Implementation of ​

ControlFlow.restore

serialize() ​

serialize(): ControlFlowCursor

Defined in: core/control-flow/loop-sequential.ts:51

Returns ​

ControlFlowCursor

可写入检查点的游标（含 iterations）

Implementation of ​

ControlFlow.serialize

MIT Licensed

Uni-Flow