Class FrozenIndexBuilder<T>

Incremental builder for FrozenMiniSearch without materializing a full documents[] array.

Type Parameters

T

Index

Constructors

Accessors

Methods

add addAll addAllAsync freezeParams

Constructors

constructor

new FrozenIndexBuilder<T>(
options: Options<T>,
hints?: FrozenIndexBuilderHints,
): FrozenIndexBuilder<T>
Type Parameters
- T
Parameters
- options: Options<T>
- Optionalhints: FrozenIndexBuilderHints
Returns FrozenIndexBuilder<T>
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:62

Accessors

documentCount

get documentCount(): number
Number of documents indexed so far (not yet frozen).

Returns number
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:89

Methods

add

add(document: T): void
Parameters
- document: T
Returns void
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:93

addAll

addAll(documents: readonly T[]): void
Adds all the given documents to the index.
Parameters
- documents: readonly T[]
  An array of documents to be indexed
Returns void
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:147

addAllAsync

addAllAsync(
documents: readonly T[],
options?: { chunkSize?: number },
): Promise<void>
Adds all the given documents to the index asynchronously.

Returns a promise that resolves (to undefined) when the indexing is done. This method is useful when indexing many documents, to avoid blocking the main thread. The indexing is performed asynchronously and in chunks. Finalize with freezeFrozenIndexBuilder when done.
Parameters
- documents: readonly T[]
  An array of documents to be indexed
- options: { chunkSize?: number } = {}
  Configuration options
Returns Promise<void>
A promise resolving to undefined when the indexing is done
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:163

freezeParams

freezeParams(): FrozenAssembleParams<T>
Finalize this builder into assembly params. Call assembleFrozen or freezeFrozenIndexBuilder to obtain a FrozenMiniSearch instance.

Returns FrozenAssembleParams<T>
- Defined in ../home/runner/work/frozenminisearch/frozenminisearch/src/frozenBuild.ts:191