Skip to content

SearchCursor

Unofficial

Cursor for navigating through search results in the editor.

Import:

import type { SearchCursor } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface SearchCursor

Methods

Method Returns Description
current() EditorRange Current editor search position.
findAll() EditorRange[] All search results.
findNext() EditorRange Next editor search position.
findPrevious() EditorRange Previous editor search position.
replace(replacement, origin) void Replace current search result with specified text.
replaceAll(replacement, origin) void Replace all search results with specified text.

Links to this page: