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

    Interface SubCallContextQueryFormat<CallName, AttachLinkInfo>

    interface SubCallContextQueryFormat<
        CallName extends CallNameTypes = CallNameTypes,
        AttachLinkInfo = NoInfo,
    > {
        callName: CallName;
        callNameExact?: boolean;
        callTargets?: CallTargets;
        fileFilter?: FileFilter<CallName>;
        ignoreParameterValues?: boolean;
        includeAliases?: boolean;
        kind?: string;
        linkTo:
            | LinkTo<CallName, AttachLinkInfo>
            | LinkTo<CallName, AttachLinkInfo>[];
        subkind?: string;
        type: "call-context";
    }

    Type Parameters

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of SubCallContextQueryFormat
    Index

    Properties

    callName callNameExact? callTargets? fileFilter? ignoreParameterValues? includeAliases? kind? linkTo subkind? type

    Properties

    callName: CallName

    Regex regarding the function name, please note that strings will be interpreted as regular expressions too!

    callNameExact?: boolean

    Should we automatically add the ^ and $ anchors to the regex to make it an exact match, we now also allow '.' etc. to have their conventional meaning if you pass in the regex as a string?

    callTargets?: CallTargets

    Call targets the function may have. This defaults to CallTargets#Any. Request this specifically to gain all call targets we can resolve.

    fileFilter?: FileFilter<CallName>

    Filter that, when set, a node's file attribute must match to be considered

    ignoreParameterValues?: boolean

    Should we ignore default values for parameters in the results?

    includeAliases?: boolean

    Consider a case like f <- function_of_interest, do you want uses of f to be included in the results?

    kind?: string

    kind may be a step or anything that you attach to the call, this can be used to group calls together (e.g., linking ggplot to visualize). Defaults to .

    linkTo: LinkTo<CallName, AttachLinkInfo> | LinkTo<CallName, AttachLinkInfo>[]
    subkind?: string

    subkinds are used to uniquely identify the respective call type when grouping the output (e.g., the normalized name, linking ggplot to plot). Defaults to .

    type: "call-context"

    used to select the query type :)

    Settings

    Member Visibility

    On This Page

    Properties