OptionaldescriptionFree-form description shown on the root spec node.
OptionalfailOnly meaningful for flowChartSelector (a root selector). When the
selector picks ≥2 branches they fan out in parallel: failFast: true
uses Promise.all (first branch error rejects + aborts), the default
uses Promise.allSettled (best-effort — all branches run even if some
fail). Use fail-fast when all selected branches are REQUIRED. Ignored for
non-selector charts. Same flag addSelectorFunction / addListOfFunction
expose.
OptionalretryDeclarative retry policy for the chart's FIRST stage (the one this factory
declares). Later stages use the .retry() modifier, or the retry option
at their own declaration site. See RetryPolicy.
OptionalstructureBuild-time recorders to attach BEFORE start() fires. Equivalent
to chaining .attachStructureRecorder(rec) immediately after the
factory returns — but registered EARLIER, so even the seed event
fires through the dispatcher without needing the seed-replay path.
Multiple recorders attach in array order (same as
.attachStructureRecorder repeated). See StructureRecorder JSDoc
for event semantics, ordering invariants, and the trust model.
OptionaltagsDeclared tags for the chart's FIRST stage. Later stages use the .tag()
modifier, or the tags option at their own declaration site. A tag is a
NAME declared at build time — never a value — and is stamped on every
commit bundle the stage records (CommitBundle.tags), so a stored
recording carries its own milestones. See FlowChartBuilder.tag.
OptionaltouchesThe outside system the chart's FIRST stage changes, and its idempotency-key
rule (10.1). Later stages use the .touches() modifier, or the touches
option at their own declaration site. See StageTouches.
Options-bag argument shape for the
flowChart()factory.