types.md

@wholebuzz/search / Exports / types

Module: types

Table of contents

Interfaces

• Dataset
• DocIdDatabase
• DocStats
• Document
• DocumentDatabase
• EmbeddedLabeledDataset
• EmbeddedLabeledLexiconDataset
• EmbeddedLabeledTextDataset
• FingerprintedLabeledDataset
• FingerprintedLabeledLexiconDataset
• FingerprintedLabeledTextDataset
• HasDocId
• HasEmbedding
• HasFingerprint
• HasScore
• IdValue
• LabeledDataset
• LabeledLexiconDataset
• LabeledTextDataset
• Lexicon
• LexiconDataset
• Posting
• PostingList
• PostingListDatabase
• SearchInterface
• TextDataset

Type aliases

• GetItemEmbedding
• GetItemFingerprint
• GetItemLabel
• ItemEmbedding
• ItemFingerprint
• ItemLabel
• SetItemEmbedding
• SetItemFingerprint

Type aliases

GetItemEmbedding

Ƭ GetItemEmbedding<Item>: (item: Item) => ItemEmbedding

Type parameters

Name
Item

Type declaration

▸ (item: Item): ItemEmbedding

Parameters

Name	Type
item	Item

Returns: ItemEmbedding

Defined in: src/types.ts:5

---

GetItemFingerprint

Ƭ GetItemFingerprint<Item>: (item: Item) => ItemFingerprint

Type parameters

Name
Item

Type declaration

▸ (item: Item): ItemFingerprint

Parameters

Name	Type
item	Item

Returns: ItemFingerprint

Defined in: src/types.ts:7

---

GetItemLabel

Ƭ GetItemLabel<Item>: (item: Item) => ItemLabel

Type parameters

Name
Item

Type declaration

▸ (item: Item): ItemLabel

Parameters

Name	Type
item	Item

Returns: ItemLabel

Defined in: src/types.ts:4

---

ItemEmbedding

Ƭ ItemEmbedding: number[]

Defined in: src/types.ts:2

---

ItemFingerprint

Ƭ ItemFingerprint: bigint

Defined in: src/types.ts:3

---

ItemLabel

Ƭ ItemLabel: string

Defined in: src/types.ts:1

---

SetItemEmbedding

Ƭ SetItemEmbedding<Item>: (item: Item, embedding?: ItemEmbedding) => Item

Type parameters

Name
Item

Type declaration

▸ (item: Item, embedding?: ItemEmbedding): Item

Parameters

Name	Type
item	Item
embedding?	ItemEmbedding

Returns: Item

Defined in: src/types.ts:6

---

SetItemFingerprint

Ƭ SetItemFingerprint<Item>: (item: Item, fingerprint?: ItemFingerprint) => Item

Type parameters

Name
Item

Type declaration

▸ (item: Item, fingerprint?: ItemFingerprint): Item

Parameters

Name	Type
item	Item
fingerprint?	ItemFingerprint

Returns: Item

Defined in: src/types.ts:8