@eagleoutice/flowr - v2.10.1
    Preparing search index...
    Dataflow: {
        create: {
            empty: (
                this: void,
                cleanEnv?: REnvironmentInformation,
                idMap?: AstIdMap,
            ) => DataflowGraphBuilder<DataflowGraphVertexInfo>;
        };
        diffGraphs<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
            this: void,
            left: NamedGraph<G>,
            right: NamedGraph<G>,
            config?: Partial<GenericDiffConfiguration>,
        ): GraphDifferenceReport;
        edge: {
            doesNotIncludeType(
                this: void,
                __namedParameters: DfEdgeLike,
                any: EdgeType,
            ): boolean;
            includesType(
                this: void,
                __namedParameters: DfEdgeLike,
                typesToInclude: EdgeType,
            ): boolean;
            name: "DfEdge";
            splitTypes(this: void, __namedParameters: DfEdgeLike): EdgeType[];
            typesToNames(this: void, __namedParameters: DfEdgeLike): Set<EdgeTypeName>;
            typeToName(this: void, type: EdgeType): string;
        };
        graph: typeof DataflowGraph;
        invertGraph<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
            this: void,
            graph: G,
            cleanEnv: REnvironmentInformation,
        ): G;
        name: "Dataflow";
        origin: (
            this: void,
            dfg: DataflowGraph,
            id: NodeId,
        ) => Origin[] | undefined;
        provenance(
            this: void,
            id: NodeId,
            graph: DataflowGraph,
            consider?: ReadonlySet<NodeId>,
        ): Set<NodeId>;
        provenanceGraph(
            this: void,
            id: NodeId,
            graph: DataflowGraph,
            consider?: ReadonlySet<NodeId>,
        ): DataflowGraph;
        reaches<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
            this: void,
            from: NodeId,
            to: NodeId,
            graph: G,
            knownReachability?: DefaultMap<NodeId, Set<NodeId>>,
        ): boolean;
        reduceGraph<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
            this: void,
            graph: G,
            select: ReadonlySet<NodeId>,
            includeMissingTargets?: boolean,
        ): G;
        resolveGraphCriteria<
            G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
        >(
            graph: G,
            ctx: ReadOnlyFlowrAnalyzerContext,
            idMap?: AstIdMap,
        ): G;
        views: {
            callGraph: {
                compute(this: void, graph: DataflowGraph): CallGraph;
                computeSubCallGraph(
                    this: void,
                    graph: CallGraph,
                    entryPoints: Set<NodeId>,
                ): CallGraph;
                diffGraphs<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
                    this: void,
                    left: NamedGraph<G>,
                    right: NamedGraph<G>,
                    config?: Partial<GenericDiffConfiguration>,
                ): GraphDifferenceReport;
                dropTransitiveEdges(this: void, graph: CallGraph): CallGraph;
                invertGraph<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
                    this: void,
                    graph: G,
                    cleanEnv: REnvironmentInformation,
                ): G;
                name: "CallGraph";
                reaches<G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>>(
                    this: void,
                    from: NodeId,
                    to: NodeId,
                    graph: G,
                    knownReachability?: DefaultMap<NodeId, Set<NodeId>>,
                ): boolean;
                resolveGraphCriteria<
                    G extends DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
                >(
                    graph: G,
                    ctx: ReadOnlyFlowrAnalyzerContext,
                    idMap?: AstIdMap,
                ): G;
                visualize: {
                    mermaid: {
                        convert(
                            this: void,
                            config: MermaidGraphConfiguration,
                        ): { mermaid: MermaidGraph; string: string };
                        name: "DataflowMermaid";
                        raw(
                            this: void,
                            graph:
                                | DataflowInformation
                                | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
                            includeEnvironments?: boolean,
                            mark?: ReadonlySet<NodeId>,
                            simplified?: boolean,
                        ): string;
                        url(
                            this: void,
                            graph:
                                | DataflowInformation
                                | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
                            includeEnvironments?: boolean,
                            mark?: ReadonlySet<NodeId>,
                            simplified?: boolean,
                        ): string;
                    };
                    quads: {
                        convert: (
                            graph: DataflowGraph,
                            config: QuadSerializationConfiguration,
                        ) => string;
                    };
                };
            };
        };
        visualize: {
            mermaid: {
                convert(
                    this: void,
                    config: MermaidGraphConfiguration,
                ): { mermaid: MermaidGraph; string: string };
                name: "DataflowMermaid";
                raw(
                    this: void,
                    graph:
                        | DataflowInformation
                        | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
                    includeEnvironments?: boolean,
                    mark?: ReadonlySet<NodeId>,
                    simplified?: boolean,
                ): string;
                url(
                    this: void,
                    graph:
                        | DataflowInformation
                        | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
                    includeEnvironments?: boolean,
                    mark?: ReadonlySet<NodeId>,
                    simplified?: boolean,
                ): string;
            };
            quads: {
                convert: (
                    graph: DataflowGraph,
                    config: QuadSerializationConfiguration,
                ) => string;
            };
        };
    } = ...

    This is the root helper object to work with the DataflowGraph.

    • Dataflow.visualize - for visualization helpers (e.g., rendering the DFG as a mermaid graph),
    • Dataflow.views - for working with specific views of the dataflow graph (e.g., the call graph),
    • Dataflow.edge - for working with the edges in the dataflow graph,

    Type Declaration