Skip to content

Type Editor


Type Editor / @type-editor/search / search-query/scan-textblocks / scanTextblocks

Function: scanTextblocks()

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

Defined in: search-query/scan-textblocks.ts:17

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

ParameterTypeDefault valueDescription
nodeNode_2undefinedThe node to scan
fromnumberundefinedThe start position of the range
tonumberundefinedThe end position of the range
callback(node, startPos) => TundefinedFunction called for each text block, should return a result or null to continue
nodeStartnumber0The starting position of the current node in the document

Returns

T

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