@eagleoutice/flowr - v2.17.4
    Preparing search index...

    Interface DataflowGraphVertexFunctionDefinition

    Arguments required to construct a vertex which represents the definition of a function in the DataflowGraph|dataflow graph.

    interface DataflowGraphVertexFunctionDefinition {
        cds: readonly ControlDependency[] | undefined;
        environment?: REnvironmentInformation;
        envOps?: readonly DeferredEnvOp[];
        exitPoints: readonly ExitPoint[];
        framed?: true;
        id: NodeId;
        link?: DataflowGraphVertexAstLink;
        mode?: FunctionDispatch[];
        params: Record<NodeId, boolean>;
        returnEnvState?: REnvironmentInformation;
        subflow: DataflowFunctionFlowInformation;
        tag: FunctionDefinition;
        [key: string]: unknown;
    }

    Hierarchy

    • DataflowGraphVertexBase
      • DataflowGraphVertexFunctionDefinition

    Indexable

    • [key: string]: unknown
    Index
    cds: readonly ControlDependency[] | undefined

    ControlDependency - the collection of control dependencies which have an influence on whether the vertex is executed.

    The environment in which the function is defined (this is only attached if the DFG deems it necessary).

    envOps?: readonly DeferredEnvOp[]

    The calls of the body whose environment operation depends on the call of the function, see DeferredEnvOp.

    exitPoints: readonly ExitPoint[]

    All exit points of the function definitions. In other words: last expressions/return calls

    framed?: true

    Whether a call of the closure reads writes into the frame it holds, see InGraphIdentifierDefinition#closureFrame.

    id: NodeId

    The id of the node (the id assigned by the ParentInformation decoration).

    Describes the collection of AST vertices that contributed to this vertex.

    If the function is a (potential) S3/S4/S7 dispatch Please note that flowR may create these flags on use (e.g. s3 as otherwise any func with a . would be considered S3).

    params: Record<NodeId, boolean>

    Maps each param to whether it is read, this is an estimate!

    returnEnvState?: REnvironmentInformation

    If this function statically returns a tracked environment, stores the envState it returns.

    The static subflow of the function definition, constructed within processFunctionDefinition.

    Used to identify and separate different types of vertices.