Type Alias IndexedDocument<Document, SummaryField>

Represents an indexed document in the search index.

type IndexedDocument<Document, SummaryField extends keyof Document> = {
signatures: Record<number, BloomFilter<string>>;
summary: Pick<Document, SummaryField>;
}

Type Parameters

Document
The type of document being indexed.
SummaryField extends keyof Document
The document keys that can be returned in search results.

Index

Properties

signatures summary

Properties

`Readonly`signatures

signatures: Record<number, BloomFilter<string>>

Bloom filter signatures for the document grouped by word frequency. Any words added to a signature are searchable but not retrievable.

`Readonly`summary

summary: Pick<Document, SummaryField>

Summary fields for the document. These are preserved as-is.