Skip to main content

modules/search/search

Namespaces​

Interfaces​

FindOptions​

Defined in: modules/search/search.d.ts:42

Constraints and filters applied when executing a search query.

Extended by​

Properties​

excludes?​

optional excludes?: string[]

Defined in: modules/search/search.d.ts:54

Array of glob patterns defining files or directories to skip (e.g., ['node_modules', '*.min.js']).

includes?​

optional includes?: string[]

Defined in: modules/search/search.d.ts:52

Array of glob patterns defining files to exclusively search inside (e.g., ['*.ts', 'src/**']).

matchCase?​

optional matchCase?: boolean

Defined in: modules/search/search.d.ts:46

Whether the search should strictly match casing (e.g., 'A' != 'a').

query​

query: string

Defined in: modules/search/search.d.ts:44

The literal text or regular expression to search for.

useRegex?​

optional useRegex?: boolean

Defined in: modules/search/search.d.ts:50

Evaluates the query string as a Regular Expression if true.

wholeWord?​

optional wholeWord?: boolean

Defined in: modules/search/search.d.ts:48

Whether the search should only match full, isolated words.

ReplaceOptions​

Defined in: modules/search/search.d.ts:60

Parameters required to perform a text replacement operation.

Properties​

filePath?​

optional filePath?: string

Defined in: modules/search/search.d.ts:64

Optional target file. If omitted, applies the replacement across ALL files currently in the results.

matchId?​

optional matchId?: string

Defined in: modules/search/search.d.ts:66

Optional target match ID. If omitted, applies the replacement to ALL matches inside the targeted file.

replacement​

replacement: string

Defined in: modules/search/search.d.ts:62

The text string that will replace the matched queries.

SearchFileResult​

Defined in: modules/search/search.d.ts:26

Represents a file that contains one or more search matches.

Properties​

dirPath​

dirPath: string

Defined in: modules/search/search.d.ts:32

The parent directory path of the file.

expanded​

expanded: boolean

Defined in: modules/search/search.d.ts:36

UI State: Whether the file's match list is expanded in the sidebar.

fileName​

fileName: string

Defined in: modules/search/search.d.ts:30

The base name of the file (e.g., 'index.ts').

filePath​

filePath: string

Defined in: modules/search/search.d.ts:28

Absolute canonical path to the file.

matches​

matches: SearchMatch[]

Defined in: modules/search/search.d.ts:34

Array of all matches discovered within this specific file.

SearchMatch​

Defined in: modules/search/search.d.ts:8

Represents an individual text match found within a file.

Properties​

column​

column: number

Defined in: modules/search/search.d.ts:14

The 1-based column number where the match begins.

id​

id: string

Defined in: modules/search/search.d.ts:10

Unique identifier for this specific match occurrence.

line​

line: number

Defined in: modules/search/search.d.ts:12

The 1-based line number where the match occurred.

matchLength​

matchLength: number

Defined in: modules/search/search.d.ts:20

The character length of the matched text.

matchStart​

matchStart: number

Defined in: modules/search/search.d.ts:18

The zero-based index of the match within the preview string.

preview​

preview: string

Defined in: modules/search/search.d.ts:16

A small text snippet of the line containing the match (used for UI preview).

SilentSearchOptions​

Defined in: modules/search/search.d.ts:72

Extended options for silent, programmatic background searches.

Extends​

Properties​

basePath?​

optional basePath?: string

Defined in: modules/search/search.d.ts:74

Optional override for the root directory to search within. Defaults to the active workspace.

excludes?​

optional excludes?: string[]

Defined in: modules/search/search.d.ts:54

Array of glob patterns defining files or directories to skip (e.g., ['node_modules', '*.min.js']).

Inherited from​

FindOptions.excludes

includes?​

optional includes?: string[]

Defined in: modules/search/search.d.ts:52

Array of glob patterns defining files to exclusively search inside (e.g., ['*.ts', 'src/**']).

Inherited from​

FindOptions.includes

matchCase?​

optional matchCase?: boolean

Defined in: modules/search/search.d.ts:46

Whether the search should strictly match casing (e.g., 'A' != 'a').

Inherited from​

FindOptions.matchCase

query​

query: string

Defined in: modules/search/search.d.ts:44

The literal text or regular expression to search for.

Inherited from​

FindOptions.query

useRegex?​

optional useRegex?: boolean

Defined in: modules/search/search.d.ts:50

Evaluates the query string as a Regular Expression if true.

Inherited from​

FindOptions.useRegex

wholeWord?​

optional wholeWord?: boolean

Defined in: modules/search/search.d.ts:48

Whether the search should only match full, isolated words.

Inherited from​

FindOptions.wholeWord

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

ConfigurationProperty​

Re-exports ConfigurationProperty

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

DocumentSymbol​

Re-exports DocumentSymbol

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IConfigurationSection​

Re-exports IConfigurationSection

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

InputBoxOptions​

Re-exports InputBoxOptions

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

RecentWorkspace​

Re-exports RecentWorkspace

ResolvedIcon​

Re-exports ResolvedIcon

Selection​

Re-exports Selection

SettingOption​

Re-exports SettingOption

SettingType​

Re-exports SettingType

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

StashOptions​

Re-exports StashOptions

StatusBarAlignment​

Re-exports StatusBarAlignment

StatusBarItemController​

Re-exports StatusBarItemController

StatusBarItemOptions​

Re-exports StatusBarItemOptions

SymbolKind​

Re-exports SymbolKind

SymbolProvider​

Re-exports SymbolProvider

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

TreeDataProvider​

Re-exports TreeDataProvider

TreeItem​

Re-exports TreeItem

TreeView​

Re-exports TreeView

TreeViewOptions​

Re-exports TreeViewOptions

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceConfiguration​

Re-exports WorkspaceConfiguration

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions