vaultmd

Appearance

vaultmd / SearchHit

Type Alias: SearchHit ​

SearchHit = object

Defined in: src/query/models/search-hit.ts:2

A single result returned by QueryApi.searchText.

Properties ​

path ​

path: string

Defined in: src/query/models/search-hit.ts:4

Vault-relative path of the matching note.

snippet? ​

optional snippet?: string

Defined in: src/query/models/search-hit.ts:8

FTS5-highlighted excerpt showing where the query terms appear in the note body.

title ​

title: string

Defined in: src/query/models/search-hit.ts:6

Derived title of the matching note.