FlowDefinition

@forge/monorepo

---

@forge/monorepo / backend/src / FlowDefinition

Type Alias: FlowDefinition

FlowDefinition = object

Defined in: backend/src/flows/index.ts:166

Properties

budget

readonly budget: FlowBudget

Defined in: backend/src/flows/index.ts:174

---

description?

readonly optional description?: string

Defined in: backend/src/flows/index.ts:171

---

id

readonly id: string

Defined in: backend/src/flows/index.ts:167

---

maxDepth?

readonly optional maxDepth?: number

Defined in: backend/src/flows/index.ts:183

How deep a subflow or a team may nest.

Enforced rather than documented, and it is what makes A → B → A terminate: each level carries its depth, and a step that would exceed the bound fails the flow with a message naming the chain. A cycle detector over the definition graph would not be enough, because a subflow reference is resolved at run time and the graph is only known then.

---

name

readonly name: string

Defined in: backend/src/flows/index.ts:170

---

start

readonly start: string

Defined in: backend/src/flows/index.ts:173

---

steps

readonly steps: readonly FlowStep[]

Defined in: backend/src/flows/index.ts:172

---

version

readonly version: number

Defined in: backend/src/flows/index.ts:169

Immutable per version. An execution pins one and reads it forever — see the module comment.