Skip to content

Type Editor


Type Editor / @type-editor/search / SearchState / SearchState

Class: SearchState

Defined in: SearchState.ts:11

Internal state for the search plugin, maintaining the current search query, optional search range, and decoration set for highlighting matches.

Constructors

Constructor

ts
new SearchState(
   query,
   range,
   deco): SearchState;

Defined in: SearchState.ts:23

Creates a new SearchState instance.

Parameters

ParameterTypeDescription
querySearchQueryThe search query to use
rangeDocumentRangeOptional range to limit search scope
decoDecorationSetDecoration set for highlighting matches

Returns

SearchState

Accessors

deco

Get Signature

ts
get deco(): DecorationSet;

Defined in: SearchState.ts:46

Gets the decoration set for highlighting matches.

Returns

DecorationSet


query

Get Signature

ts
get query(): SearchQuery;

Defined in: SearchState.ts:32

Gets the current search query.

Returns

SearchQuery


range

Get Signature

ts
get range(): DocumentRange;

Defined in: SearchState.ts:39

Gets the current search range, if any.

Returns

DocumentRange