Skip to content

obsidian/property-entry

The property:name / property:name=value entry syntax shared by the settings lists that can match a note by its frontmatter.

Two lists read it today: note priorities (findNotePriorityRank) and the attachment extensions of isTreatedAsAttachment. Both match through the one function here, so an entry the user writes in one list means exactly the same thing in the other.

Interface Description
CheckPropertyEntryMatchesParams Parameters for checkPropertyEntryMatches.
Function Description
checkPropertyEntryMatches Checks whether a note’s frontmatter matches a property:name or property:name=value entry. A value is compared by its rendering, since frontmatter values are whatever YAML produced, and an array matches when any of its items does, which is how tag-like properties read. An entry without the PROPERTY_ENTRY_PREFIX matches nothing.
isPropertyEntry Checks whether a settings entry is a frontmatter property match.
Variable Description
PROPERTY_ENTRY_PREFIX The prefix that marks a settings entry as a frontmatter property match.