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

    Variable Query

    Query: {
        calls(
            this: void,
            results: Partial<QueryResults<"call-context">>,
        ): FoundCall[];
        entries<
            Base extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
            Type extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
        >(
            this: void,
            results: QueryResults<Base>,
            type: Type,
        ): [Extract<keyof (...), string>, ValueOf<Type>][];
        first<
            Base extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
            Type extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
        >(
            this: void,
            results: QueryResults<Base>,
            type: Type,
        ): ValueOf<Type> | undefined;
        get<
            Base extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
            Type extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
        >(
            this: void,
            results: QueryResults<Base>,
            type: Type,
            key: Extract<keyof ResultsOf<Type>>,
        ): ValueOf<Type> | undefined;
        lints(this: void, results: Partial<QueryResults<"linter">>): FoundLint[];
        name: string;
        one<
            Type extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
        >(
            this: void,
            data: BasicQueryData,
            query:
                | Extract<
                    DefaultCallContextQueryFormat<CallNameTypes>,
                    { type: Type },
                >
                | Extract<
                    SubCallContextQueryFormat<CallNameTypes, object>,
                    { type: Type },
                >
                | Extract<ConfigQuery, { type: Type }>
                | Extract<SearchQuery, { type: Type }>
                | Extract<DataflowQuery, { type: Type }>
                | Extract<DoesCallQuery, { type: Type }>
                | Extract<CallGraphQuery, { type: Type }>
                | Extract<ControlFlowQuery, { type: Type }>
                | Extract<DataflowLensQuery, { type: Type }>
                | Extract<FilesQuery, { type: Type }>
                | Extract<AbsintQuery<"df-shape">, { type: Type }>
                | Extract<NormalizedAstQuery, { type: Type }>
                | Extract<IdMapQuery, { type: Type }>
                | Extract<DataflowClusterQuery, { type: Type }>
                | Extract<StaticSliceQuery, { type: Type }>
                | Extract<DependenciesQuery, { type: Type }>
                | Extract<LocationMapQuery, { type: Type }>
                | Extract<HappensBeforeQuery, { type: Type }>
                | Extract<InspectExceptionQuery, { type: Type }>
                | Extract<InspectHigherOrderQuery, { type: Type }>
                | Extract<InspectRecursionQuery, { type: Type }>
                | Extract<InspectFnPropsQuery, { type: Type }>
                | Extract<ResolveValueQuery, { type: Type }>
                | Extract<ProjectQuery, { type: Type }>
                | Extract<SignatureQuery, { type: Type }>
                | Extract<OriginQuery, { type: Type }>
                | Extract<LinterQuery, { type: Type }>
                | Extract<ProvenanceQuery, { type: Type }>
                | Extract<InputSourcesQuery, { type: Type }>
                | Extract<DiceQuery, { type: Type }>
                | Extract<GuessDepVersionsQuery, { type: Type }>,
        ): Promise<Awaited<ReturnType<(...)[(...)]>>>;
        values<
            Base extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
            Type extends
                | "search"
                | "project"
                | "linter"
                | "config"
                | "dependencies"
                | "dataflow"
                | "files"
                | "call-context"
                | "does-call"
                | "call-graph"
                | "control-flow"
                | "dataflow-lens"
                | "absint"
                | "normalized-ast"
                | "id-map"
                | "dataflow-cluster"
                | "static-slice"
                | "location-map"
                | "happens-before"
                | "inspect-exception"
                | "inspect-higher-order"
                | "inspect-recursion"
                | "inspect-fn-props"
                | "resolve-value"
                | "signature"
                | "origin"
                | "provenance"
                | "input-sources"
                | "dice"
                | "guess-dep-versions",
        >(
            this: void,
            results: QueryResults<Base>,
            type: Type,
        ): ValueOf<Type>[];
    }

    Running queries and reading what they reported, without Object.entries and the casts it forces. Reading changes nothing: the results keep the shape they are serialized in.

    Type Declaration

    • calls: function

      • Every call a call-context query found, flat, each carrying the kind and subkind it was found under rather than leaving them as the two levels of record the result nests them in.

        Parameters

        Returns FoundCall[]

    • entries: function

      • Every key and result of one query, typed as that query reports them.

        Type Parameters

        • Base extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"
        • Type extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"

        Parameters

        Returns [Extract<keyof (...), string>, ValueOf<Type>][]

    • first: function

      • The one result of a query that was asked for one thing, undefined when it reported none.

        Type Parameters

        • Base extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"
        • Type extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"

        Parameters

        Returns ValueOf<Type> | undefined

    • get: function

      • The result of one query under one key, undefined when it reported none.

        Type Parameters

        • Base extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"
        • Type extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"

        Parameters

        Returns ValueOf<Type> | undefined

    • lints: function
    • name: string
    • one: function
    • values: function

      • Every result of one query, for when the keys are not what you are after.

        Type Parameters

        • Base extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"
        • Type extends
              | "search"
              | "project"
              | "linter"
              | "config"
              | "dependencies"
              | "dataflow"
              | "files"
              | "call-context"
              | "does-call"
              | "call-graph"
              | "control-flow"
              | "dataflow-lens"
              | "absint"
              | "normalized-ast"
              | "id-map"
              | "dataflow-cluster"
              | "static-slice"
              | "location-map"
              | "happens-before"
              | "inspect-exception"
              | "inspect-higher-order"
              | "inspect-recursion"
              | "inspect-fn-props"
              | "resolve-value"
              | "signature"
              | "origin"
              | "provenance"
              | "input-sources"
              | "dice"
              | "guess-dep-versions"

        Parameters

        Returns ValueOf<Type>[]

    const out = await executeQueries({ analyzer }, [{ type: 'static-slice', criteria: ['2@x'] }]);
    Query.get(out, 'static-slice', '2@x');                       // the slice taken at `2@x`
    Query.first(out, 'static-slice');                            // the only slice, when one was asked for
    for(const [criterion, slice] of Query.entries(out, 'static-slice')) { ... }

    Settings
    Member Visibility