SearchMatchResult

Unofficial

Both Official Unofficial

Both Own Inherited

The result of matching a search query, keyed by the input each range was found in.

A canvas file’s result also carries one canvas-<nodeId> entry per matching text node.

Import:

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

Signature:

export interface SearchMatchResult

Properties

	Property	Type	Description
	content?	ContentPosition[]	Ranges matched in the content.
	filename?	ContentPosition[]	Ranges matched in the file name.
	filepath?	ContentPosition[]	Ranges matched in the file path.
	properties?	ResultProperty[]	Matched frontmatter properties.
	propertyName?	ContentPosition[]	Ranges matched in a property name.
	tag?	ContentPosition[]	Ranges matched in a tag.

---

Links to this page:

• ObsidianSearchQuery
• SearchMatcher
• SearchPropertyMatcher