SearchQuery

Unofficial

Both Official Unofficial

Both Own Inherited

Represents a search query with its configuration and methods for searching.

Import:

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

Signature:

export class SearchQuery

Properties

	Property	Type	Description
	caseSensitive	boolean	Whether the search is case sensitive.
	literal	boolean	Whether the search string is treated as a literal.
	regexp	boolean	Whether the search string is a regular expression.
	replace	string	The replacement string.
	search	string	The search string.
	valid	boolean	Whether the search query is valid.
	wholeWord	boolean	Whether the search matches whole words only.

Methods

	Method	Returns	Description
	eq(other)	boolean	Check whether this query is equal to another.
	getCursor(state, from?, to?)	Iterator<SearchQueryMatch>	Get a cursor for iterating over matches.

---

Links to this page:

• CodeMirrorEditor