Skip to content

Type Editor


Type Editor / @type-editor/search / types/SearchQueryConfig / SearchQueryConfig

Interface: SearchQueryConfig

Defined in: types/SearchQueryConfig.ts:7

Configuration options for creating a search query.

Properties

PropertyTypeDescriptionDefined in
caseSensitive?booleanControls whether the search should be case-sensitive. Default falsetypes/SearchQueryConfig.ts:17
filter?(state, result) => booleanOptional filter function that can exclude certain search results. Results for which this function returns false will be ignored.types/SearchQueryConfig.ts:55
literal?booleanBy 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 falsetypes/SearchQueryConfig.ts:25
regexp?booleanWhen true, interpret the search string as a regular expression. Default falsetypes/SearchQueryConfig.ts:31
replace?stringThe replacement text to use when performing replacements. Supports capture group references like $1, $2, and $& for regex searches. Default ''types/SearchQueryConfig.ts:38
searchstringThe search string or regular expression pattern.types/SearchQueryConfig.ts:11
wholeWord?booleanEnable whole-word matching. When enabled, matches that are surrounded by word characters will be ignored. Default falsetypes/SearchQueryConfig.ts:45