Interface FlowrSearchGetFilter

interface FlowrSearchGetFilter {
    column?: number;
    filePathRegex?: string;
    id?: NodeId;
    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

Properties

column? filePathRegex? id? line? name? nameIsRegex?

Properties

Optional Readonlycolumn

column?: number

The node must be in the given column.

Optional ReadonlyfilePathRegex

filePathRegex?: string

The node must stem form a file with the given path matching the regex Please note that you can address the full path!

Example

// matches all files in any 'tests' folder
filePath: '.*\\tests\\.*'
// matches all files named 'myfile.R' in any folder
filePath: '.*\\/myfile\\.R$'

Optional Readonlyid

id?: NodeId

The node must have the given id.

Optional Readonlyline

line?: number

The node must be in the given line.

Optional Readonlyname

name?: string

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

Optional ReadonlynameIsRegex

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