Skip to content
1 min read · 130 words

Function: planOutline()

ts
function planOutline(store: PlanStore, planId: string): Promise<PlanOutline>;

Defined in: src/batteries/orchestration/outline.ts:64

Build a flat outline of a plan: one entry per phase, plus a single entry for unphased nodes.

Parameters

ParameterTypeDescription
storePlanStorethe plan store to read from.
planIdstringthe id of the plan to outline.

Returns

Promise<PlanOutline>

the flat outline of the plan.

Remarks

Each PhaseEntry carries the exact surface forms a reader needs to fetch a slice — the phase name, the node ids, the tool names of every call node, an open-issue count, and a one-line summary. The outline is deliberately a single flat list with no second routing level; see the module doc for why.