ResultProperty

Unofficial

Both Official Unofficial

Both Own Inherited

Represents a matched property within a search result.

Import:

import type { ResultProperty } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ResultProperty

Properties

	Property	Type	Description
	key	string	Property key name that was matched.
	pos?	ContentPosition	ContentPosition of the match within the property value, absent for a bare [key] match.
	subkey?	(number | string)[]	Path below ResultProperty.key, one entry per segment. The search matcher sets it only for a match inside an array value, to the index of the matched item, as a one-element array. The backlink recompute always sets it, from a frontmatterLinks key split on .: the segments after the first, each a number when it parses as one and the string otherwise, so a bare key gives an empty array and a.b gives ['b'].

---

Links to this page:

• ResultDomItemPropertyChild
• ResultDomResult
• SearchMatchResult