Type Editor

---

Type Editor / @type-editor/search / search-query/StringQuery / StringQuery

Class: StringQuery

Defined in: search-query/StringQuery.ts:14

Query implementation for plain text string searches. Handles case-sensitive and case-insensitive string matching.

Extends

• AbstractQueryImpl

Implements

• QueryImpl

Constructors

Constructor

new StringQuery(query): StringQuery;

Defined in: search-query/StringQuery.ts:23

Creates a new string query implementation.

Parameters

Parameter	Type	Description
query	SearchQuery	The parent search query configuration

Returns

StringQuery

Overrides

AbstractQueryImpl.constructor

Methods

findNext()

findNext(
   state,
   from,
   to): SearchResult;

Defined in: search-query/StringQuery.ts:43

Finds the next occurrence of the search text in the document.

Parameters

Parameter	Type	Description
state	PmEditorState	The editor state to search in
from	number	The position to start searching from
to	number	The position to search up to

Returns

SearchResult

The search result if found, or null if no match exists

Implementation of

QueryImpl.findNext

---

findPrev()

findPrev(
   state,
   from,
   to): SearchResult;

Defined in: search-query/StringQuery.ts:75

Finds the previous occurrence of the search text in the document.

Parameters

Parameter	Type	Description
state	PmEditorState	The editor state to search in
from	number	The position to start searching from
to	number	The position to search back to

Returns

SearchResult

The search result if found, or null if no match exists

Implementation of

QueryImpl.findPrev

---

scanTextblocks()

protected scanTextblocks<T>(
   node,
   from,
   to,
   callback,
   nodeStart?): T;

Defined in: search-query/AbstractQueryImpl.ts:29

Scans through text blocks in a document tree, calling a callback for each text block that intersects with the given range.

Supports both forward scanning (from < to) and backward scanning (from > to).

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
node	Node_2	undefined	The node to scan
from	number	undefined	The start position of the range
to	number	undefined	The end position of the range
callback	(node, startPos) => T	undefined	Function called for each text block, should return a result or null to continue
nodeStart	number	0	The starting position of the current node in the document

Returns

T

The first non-null result from the callback, or null if none found

Inherited from

AbstractQueryImpl.scanTextblocks

---

textContent()

protected textContent(node): string;

Defined in: search-query/AbstractQueryImpl.ts:90

Extracts the text content from a node, with caching for performance.

• Text nodes contribute their text
• Leaf nodes (like images) are represented by the Object Replacement Character (U+FFFC)
• Block nodes have their content extracted recursively with spaces around them

Parameters

Parameter	Type	Description
node	Node_2	The node to extract text content from

Returns

string

The text content of the node

Inherited from

AbstractQueryImpl.textContent