SearchPropertyMatcher.match method

SearchPropertyMatcher › match

Unofficial

Matches the context's top-level frontmatter properties.

Every property whose name SearchPropertyMatcher.key matches is reported. With a SearchPropertyMatcher.value, each scalar value, or each item of an array value, is matched against it through SearchMatchContext.cloneForPropertyContent.

Signature:

match(context: SearchMatchContext): null | SearchMatchResult | undefined

Parameters:

Parameter	Type	Description
context	SearchMatchContext	The context to match.

Returns: null | SearchMatchResult | undefined — The matched properties, null when none matched, or undefined when the context has no content input.