Interface: SearchOptions
Defined in: packages/sdk/src/search-service.ts:14
Options for SearchService.search. All flags default to off / empty; an omitted options runs a plain, case-insensitive substring search over the active workspace, respecting .gitignore.
Properties
cwd?
optional cwd?: string;Defined in: packages/sdk/src/search-service.ts:20
Search root. Defaults to the open workspace folder when omitted. A cwd outside the workspace throws PathDeniedError unless the extension declared the process Permission; first-party extensions are unscoped.
regex?
optional regex?: boolean;Defined in: packages/sdk/src/search-service.ts:22
Treat query as a regular expression instead of a literal string.
caseSensitive?
optional caseSensitive?: boolean;Defined in: packages/sdk/src/search-service.ts:24
Match case exactly. When false (default), the search is case-insensitive.
wholeWord?
optional wholeWord?: boolean;Defined in: packages/sdk/src/search-service.ts:26
Match whole words only (word boundaries around the query).
includeGlobs?
optional includeGlobs?: string[];Defined in: packages/sdk/src/search-service.ts:31
Glob patterns of files to include (e.g. ["*.ts", "src/**"]). When empty, all files are eligible (still subject to .gitignore and excludeGlobs).
excludeGlobs?
optional excludeGlobs?: string[];Defined in: packages/sdk/src/search-service.ts:33
Glob patterns of files to exclude (e.g. ["**/dist/**"]), on top of .gitignore.
maxResults?
optional maxResults?: number;Defined in: packages/sdk/src/search-service.ts:38
Cap on the total number of matches collected across all files. When the cap is hit, the search stops early and SearchResponse.truncated is true.