Skip to content

ResultDomResult

Unofficial

Search result data containing matched content positions and property matches.

Every member is optional: each producer writes only the keys it matched. A canvas result carries only canvas- keys (and filename when the file name matched), the unlinked-mentions pane writes no properties, and a search match carries only the keys its query touched.

Import:

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

Signature:

export interface ResultDomResult

Properties

PropertyTypeDescription
content?ContentPosition[]Array of content match positions within the document.
filename?ContentPosition[]Match positions within the file name.
filepath?ContentPosition[]Match positions within the file path.
properties?ResultProperty[]Array of matched property results.
propertyName?ContentPosition[]Match positions within a property name.
tag?ContentPosition[]Match positions within a tag.

Links to this page: