types.documentdatabase.md

@wholebuzz/search / Exports / types / DocumentDatabase

Interface: DocumentDatabase

types.DocumentDatabase

Hierarchy

• DocumentDatabase

  ↳ PostingListDatabase

Table of contents

Methods

• addDoc
• consolidate
• defineConfig
• definePrepTasks
• getConfig
• getDocs
• getIDF
• getTokens
• getTotalCorpusLength
• getTotalDocs
• removeDoc

Methods

addDoc

▸ addDoc(doc: Record<string, string>, id: string | bigint, version?: Date): Promise<number>

Parameters

Name	Type
doc	Record<string, string>
id	string | bigint
version?	Date

Returns: Promise<number>

Defined in: src/types.ts:73

---

consolidate

▸ consolidate(precision?: number): Promise<boolean>

Parameters

Name	Type
precision?	number

Returns: Promise<boolean>

Defined in: src/types.ts:75

---

defineConfig

▸ defineConfig(config: Record<string, any>): boolean

Parameters

Name	Type
config	Record<string, any>

Returns: boolean

Defined in: src/types.ts:70

---

definePrepTasks

▸ definePrepTasks(tasks: Function[], field?: string): number

Parameters

Name	Type
tasks	Function[]
field?	string

Returns: number

Defined in: src/types.ts:72

---

getConfig

▸ getConfig(): Record<string, any>

Returns: Record<string, any>

Defined in: src/types.ts:79

---

getDocs

▸ getDocs(): Record<string, Document>

Returns: Record<string, Document>

Defined in: src/types.ts:76

---

getIDF

▸ getIDF(): number[]

Returns: number[]

Defined in: src/types.ts:78

---

getTokens

▸ getTokens(): Record<string, number>

Returns: Record<string, number>

Defined in: src/types.ts:77

---

getTotalCorpusLength

▸ getTotalCorpusLength(): number

Returns: number

Defined in: src/types.ts:80

---

getTotalDocs

▸ getTotalDocs(): number

Returns: number

Defined in: src/types.ts:81

---

removeDoc

▸ removeDoc(doc: Record<string, string>, id: string | bigint): Promise<number>

Parameters

Name	Type
doc	Record<string, string>
id	string | bigint

Returns: Promise<number>

Defined in: src/types.ts:74