Variable QueryFunctionFilterConst

Type Declaration

• criteria: function

  • criteria(
        this: void,
        queries: readonly FunctionFilteringQuery[],
        analyzer: ReadonlyFlowrAnalysisProvider,
    ): Promise<ReadonlySet<NodeId>>

    The ids the given queries restrict themselves to; empty if at least one query wants all functions.

    Parameters

    • this: void
    • queries: readonly FunctionFilteringQuery[]
    • analyzer: ReadonlyFlowrAnalysisProvider

    Returns Promise<ReadonlySet<NodeId>>

• definitions: function

  • definitions(
        this: void,
        graph: DataflowGraph,
        filterFor: ReadonlySet<NodeId>,
    ): NodeId[]

    The definitions of graph a query answers for: the ones the analyzed code writes, narrowed to filterFor when it holds anything. One pass, as every inspection query starts with this.

    Parameters

    • this: void
    • graph: DataflowGraph
    • filterFor: ReadonlySet<NodeId>

    Returns NodeId[]

• inCallGraph: function

  • inCallGraph(
        this: void,
        queries: readonly FunctionFilteringQuery[],
        analyzer: ReadonlyFlowrAnalysisProvider,
        onlyDefinitions?: boolean,
    ): Promise<
        {
            cg: CallGraph;
            fns: IteratorObject<[(...), (...)], undefined, unknown>;
        },
    >

    The call graph together with the functions the given queries want to inspect.

    Parameters

    • this: void
    • queries: readonly FunctionFilteringQuery[]
    • analyzer: ReadonlyFlowrAnalysisProvider
    • onlyDefinitions: boolean = true

    Returns Promise<
        {
            cg: CallGraph;
            fns: IteratorObject<[(...), (...)], undefined, unknown>;
        },
    >

• Readonlyname: "QueryFunctionFilter"

• Readonlywritten: (this: void, id: NodeId) => boolean

  Whether the definition is one the analyzed code writes, as nobody asks about a function they never wrote.

  See

  NodeId.isWritten