@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface FlowGraphNode

    A node of the flow graph. Ids are stable and identical to the Mermaid node ids.

    interface FlowGraphNode {
        id: string;
        kind: FlowGraphNodeKind;
        label: string;
        flow?: string;
        group?: string;
        path?: string;
        text?: string;
        dynamic?: boolean;
        stateKey?: string;
        timeoutMs?: number;
        timeoutSource?: FlowGraphTimeoutSource;
        target?: string;
        options?: FlowGraphOption[];
        media?: { source: string; caption?: string; type?: string };
        delayMs?: number;
        schema?: boolean;
        redirect?: string;
        message?: string;
        subflow?: string;
        form?: FlowGraphFormInfo;
        action?: string;
        stepKind?: string;
    }
    Index
    id kind label flow? group? path? text? dynamic? stateKey? timeoutMs? timeoutSource? target? options? media? delayMs? schema? redirect? message? subflow? form? action? stepKind?
    id: string

    Node id, e.g. f0_in, f0_s3, f0_s3_o1_s0, f0_end, f1 (conversation), x0 (missing target).

    kind: FlowGraphNodeKind
    label: string

    Full human-readable label (lines separated by \n; never truncated).

    flow?: string

    Id of the owning FlowGraphFlow; absent for missing nodes.

    group?: string

    Innermost inline sub-flow FlowGraphGroup containing this node.

    path?: string

    Step path inside the flow, e.g. steps[3].options["tech"].then.steps[0].

    Optionaltext

    text?: string

    Literal text of a say/ask, or the prompt of a choose. Absent when computed at runtime.

    dynamic?: boolean

    true when the say/ask text is a function evaluated at runtime.

    stateKey?: string

    c.state key an ask/choose writes.

    timeoutMs?: number

    Effective wait timeout of an ask/choose in ms (0 = never expires). Absent when unparseable.

    timeoutSource?: FlowGraphTimeoutSource

    Where timeoutMs comes from.

    target?: string

    Target conversation of a goto / name of a missing node.

    options?: FlowGraphOption[]

    Options of a choose, in menu order.

    media?: { source: string; caption?: string; type?: string }

    What a media step sends (type: image, video, audio, voice, document, sticker, location).

    delayMs?: number

    Pause before the step runs ({ delay } option, or a .delay() step), in ms.

    schema?: boolean

    true when an ask validates its answer with a schema.

    redirect?: string

    Conversation a failing guard redirects to (absent: the conversation ends).

    message?: string

    Farewell text of a failing guard, when literal.

    subflow?: string

    Id of the sub-flow a use node runs inline.

    form?: FlowGraphFormInfo

    Fields of a form step, in order (the form id is in text, its c.state key in stateKey).

    action?: string

    Name of the function behind a do/then/dynamic text, when it has a meaningful one.

    stepKind?: string

    Raw step kind of an unknown (step) or explicit end step.

    Settings
    Member Visibility

    On This Page
    Properties