Type Editor / @type-editor/search / types/SearchQueryConfig / SearchQueryConfig
Interface: SearchQueryConfig
Defined in: types/SearchQueryConfig.ts:7
Configuration options for creating a search query.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
caseSensitive? | boolean | Controls whether the search should be case-sensitive. Default false | types/SearchQueryConfig.ts:17 |
filter? | (state, result) => boolean | Optional filter function that can exclude certain search results. Results for which this function returns false will be ignored. | types/SearchQueryConfig.ts:55 |
literal? | boolean | By default, string search will replace \n, \r, and \t in the query with newline, return, and tab characters. When this is set to true, that behavior is disabled. Default false | types/SearchQueryConfig.ts:25 |
regexp? | boolean | When true, interpret the search string as a regular expression. Default false | types/SearchQueryConfig.ts:31 |
replace? | string | The replacement text to use when performing replacements. Supports capture group references like $1, $2, and $& for regex searches. Default '' | types/SearchQueryConfig.ts:38 |
search | string | The search string or regular expression pattern. | types/SearchQueryConfig.ts:11 |
wholeWord? | boolean | Enable whole-word matching. When enabled, matches that are surrounded by word characters will be ignored. Default false | types/SearchQueryConfig.ts:45 |