DocumentSearchData
Defined in: types.ts:16
Search data for a single document
Note: This does NOT include routing information. Routing is the responsibility of the consuming application.
Properties
Section titled “Properties”documentId
Section titled “documentId”documentId:
string
Defined in: types.ts:18
Unique document identifier (usually absolute file path)
entries
Section titled “entries”entries:
SearchEntry[]
Defined in: types.ts:32
Searchable content entries
filters?
Section titled “filters?”
optionalfilters:object
Defined in: types.ts:25
Filter metadata (pluggable)
Index Signature
Section titled “Index Signature”[key: string]: unknown
documentType?
Section titled “documentType?”
optionaldocumentType:string
optionaltags:string[]
shortName?
Section titled “shortName?”
optionalshortName:string
Defined in: types.ts:22
Short name (if available in document metadata)
title:
string
Defined in: types.ts:20
Document title