ObsidianSearchQuery

Unofficial

Both Official Unofficial

Both Own Inherited

A parsed Obsidian search query, compiled from a raw query string into a matcher. Used by global search, the file explorer filter, and backlink search.

Import:

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

Signature:

export interface ObsidianSearchQuery

Properties

	Property	Type	Description
	app	App	Reference to the app.
	caseSensitive	boolean	Whether the query is matched case-sensitively.
	matcher	unknown	The compiled matcher for the query.
	query	string	The raw query string.
	requiredInputs	unknown	The inputs the matcher requires to evaluate a file (e.g. content, tags).

Methods

	Method	Returns	Description
	match(file, content)	unknown	Matches a file (and optionally its content) against the query.
	matchContent(content)	unknown	Matches content against the query.
	matchTag(tag)	unknown	Matches a tag against the query.

---

Links to this page:

• FileExplorerView