packages/engine/units/flow · Developer Docs

The FLOW section of a feature summary: how a URL reaches a feature's code and what that code is made of, drawn from the REAL import graph, not from a fixed layer order.

Engine, next. Source: packages/engine/units/flow.mjs.

Variables#

NOTE_NO_ROUTE#

const NOTE_NO_ROUTE: object

Defined in: packages/engine/units/flow.mjs:28

Type Declaration#

code

code: string = 'no-route'

message

message: string = 'No route reaches this feature. That is fine for a shared library.'

severity

severity: string = 'info'

Functions#

buildFlow()#

buildFlow(ctx, feature, __namedParameters?): object

Defined in: packages/engine/units/flow.mjs:44

Parameters#

ctx

any

feature

any

__namedParameters?

detail?

string = 'standard'

graph?

{ deps: Map<any, any>; files: any; importers: (p) => any; } = ...

graph.deps

Map<any, any>

graph.files

any

graph.importers

(p) => any = ...

Returns#

object

framework

framework: any

notes

notes: object[]

routeAdapter

routeAdapter: boolean = true

routes

routes: any

renderFlowMarkdown()#

renderFlowMarkdown(flow): string

Defined in: packages/engine/units/flow.mjs:98

The flow as an indented tree for humans (construct summarize <feature> --format markdown).

Parameters#

flow

any

Returns#

string