Theia API Documentation v1.66.0
    Preparing search index...

    Interface SearchInWorkspaceOptions

    interface SearchInWorkspaceOptions {
        exclude?: string[];
        followSymlinks?: boolean;
        include?: string[];
        includeIgnored?: boolean;
        matchCase?: boolean;
        matchWholeWord?: boolean;
        maxFileSize?: string;
        maxResults?: number;
        multiline?: boolean;
        useRegExp?: boolean;
    }
    Index

    Properties

    exclude? followSymlinks? include? includeIgnored? matchCase? matchWholeWord? maxFileSize? maxResults? multiline? useRegExp?

    Properties

    exclude?: string[]

    Glob pattern for matching files and directories to exclude the search.

    followSymlinks?: boolean

    Whether symlinks should be followed while searching.

    include?: string[]

    Glob pattern for matching files and directories to include the search.

    includeIgnored?: boolean

    Include all .gitignored and hidden files.

    matchCase?: boolean

    Search case sensitively if true.

    matchWholeWord?: boolean

    Search whole words only if true.

    maxFileSize?: string

    accepts suffixes of K, M or G which correspond to kilobytes, megabytes and gigabytes, respectively. If no suffix is provided the input is treated as bytes.

    defaults to '20M'

    maxResults?: number

    Maximum number of results to return. Defaults to unlimited.

    multiline?: boolean

    Use multiline search if true.

    useRegExp?: boolean

    Use regular expressions for search if true.

    Settings

    Member Visibility

    On This Page

    Properties