WorkflowBuilder
Defined in: packages/workflow/src/workflow-builder.ts:78
WorkflowBuilder - 链式构造线性 Workflow。
抛错时机:
- add() 超过 maxSteps 时立即抛错(避免构造完才发现步数超限)
- build() 在节点为空 / 输入输出未设置时抛错
- remove()/move() 在节点 id 不存在时静默(链式 API 容错)
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkflowBuilder(
options):WorkflowBuilder
Defined in: packages/workflow/src/workflow-builder.ts:86
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”WorkflowBuilder
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/workflow/src/workflow-builder.ts:204
当前节点数
Returns
Section titled “Returns”number
isFull
Section titled “isFull”Get Signature
Section titled “Get Signature”get isFull():
boolean
Defined in: packages/workflow/src/workflow-builder.ts:209
是否已达最大节点数
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”setInput()
Section titled “setInput()”setInput(
input):this
Defined in: packages/workflow/src/workflow-builder.ts:94
设置工作流输入定义
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
setOutput()
Section titled “setOutput()”setOutput(
output):this
Defined in: packages/workflow/src/workflow-builder.ts:100
设置工作流输出定义
Parameters
Section titled “Parameters”output
Section titled “output”Returns
Section titled “Returns”this
add(
capability,params?,label?):this
Defined in: packages/workflow/src/workflow-builder.ts:113
添加一个节点到链尾。
Parameters
Section titled “Parameters”capability
Section titled “capability”string
能力名,如 image.resize
params?
Section titled “params?”Record<string, unknown> = {}
能力参数(可选,默认空对象)
label?
Section titled “label?”string
节点标签(可选,UI 显示用)
Returns
Section titled “Returns”this
Throws
Section titled “Throws”Error 当节点数达到 maxSteps 时
remove()
Section titled “remove()”remove(
capabilityOrId):this
Defined in: packages/workflow/src/workflow-builder.ts:142
按 capability 或节点 id 移除节点。 若有多个同 capability 节点,只移除第一个。 若不存在则静默(链式 API 容错)。
Parameters
Section titled “Parameters”capabilityOrId
Section titled “capabilityOrId”string
能力名或节点 id
Returns
Section titled “Returns”this
move()
Section titled “move()”move(
from,to):this
Defined in: packages/workflow/src/workflow-builder.ts:159
移动节点到新位置(线性链中重排)。
Parameters
Section titled “Parameters”number
源位置(0-based 索引)
number
目标位置(0-based 索引,移动后该节点的新位置)
Returns
Section titled “Returns”this
Throws
Section titled “Throws”Error 当索引越界
swap()
Section titled “swap()”swap(
i,j):this
Defined in: packages/workflow/src/workflow-builder.ts:178
交换两个节点位置
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”this
updateParams()
Section titled “updateParams()”updateParams(
nodeId,params):this
Defined in: packages/workflow/src/workflow-builder.ts:195
更新指定节点的参数
Parameters
Section titled “Parameters”nodeId
Section titled “nodeId”string
params
Section titled “params”Record<string, unknown>
Returns
Section titled “Returns”this
getNodes()
Section titled “getNodes()”getNodes(): readonly
Readonly<BuilderNode>[]
Defined in: packages/workflow/src/workflow-builder.ts:214
获取节点的只读副本(用于 UI 预览)
Returns
Section titled “Returns”readonly Readonly<BuilderNode>[]
build()
Section titled “build()”build():
Workflow
Defined in: packages/workflow/src/workflow-builder.ts:223
构造 Workflow 实例。
Returns
Section titled “Returns”Throws
Section titled “Throws”Error 当节点为空 / 输入未设置 / 输出未设置