Skip to content

ObsidianSearchQuery.match method

ObsidianSearchQuery › match

Unofficial

Matches a file (and optionally its content) against the query.

Signature:

match(file: TFile, content: string): null | SearchMatchResult

Parameters:

ParameterTypeDescription
fileTFileThe file to match.
contentstringThe file content.

Returns: null | SearchMatchResult — The match result, or null on no match.