Skip to content

SearchQuery.getCursor method

SearchQuery › getCursor

Unofficial

Get a cursor for iterating over matches.

Signature:

getCursor(state: CmText | EditorState, from?: number | undefined, to?: number | undefined): Iterator<SearchQueryMatch>

Parameters:

ParameterTypeDescription
stateCmText | EditorStateThe text or editor state to search in.
from?number | undefinedOptional start position.
to?number | undefinedOptional end position.

Returns: Iterator<SearchQueryMatch>An iterator over match ranges.