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

    Interface FlowrSearchGetFilter

    interface FlowrSearchGetFilter {
        column?: number;
        filePathRegex?: string;
        fuzzy?: boolean;
        id?: NodeId;
        innermostOnly?: boolean;
        line?: number;
        name?: string;
        nameIsRegex?: boolean;
        [key: string]: unknown;
    }

    Hierarchy

    • Record<string, unknown>
      • FlowrSearchGetFilter

    Indexable

    • [key: string]: unknown

    Hierarchy-Diagram

    UML class diagram of FlowrSearchGetFilter
    Index

    Properties

    column? filePathRegex? fuzzy? id? innermostOnly? line? name? nameIsRegex?

    Properties

    column?: number

    The node must be in the given column.

    filePathRegex?: string

    The node must stem from a file with the given path matching the regex. Inline code (code without a file path) is treated as having an empty path "". Please note that you can address the full path!

    // matches all files in any 'tests' folder
    filePathRegex: '.*\\tests\\.*'
    // matches all files named 'myfile.R' in any folder
    filePathRegex: '.*\\/myfile\\.R$'
    // matches only inline code
    filePathRegex: '^$'
    // matches inline code or .R files
    filePathRegex: '^$|.*\\.R$'
    fuzzy?: boolean

    If true, match any node whose source range contains the given line/column (fuzzy position match). Requires line to be provided.

    id?: NodeId

    The node must have the given id.

    innermostOnly?: boolean

    If true (and fuzzy is true), return only the innermost (deepest in the AST) matching node(s).

    line?: number

    The node must be in the given line.

    name?: string

    The node must have the given name. To treat this name as a regular expression, set FlowrSearchGetFilter#nameIsRegex to true.

    nameIsRegex?: boolean

    Only useful in combination with name. If true, the name is treated as a regular expression.

    Settings

    Member Visibility

    On This Page

    Properties