Class FrozenMiniSearch<T>

Static Readonlywildcard

documentCount

• get documentCount(): number

  Returns number

termCount

• get termCount(): number

  Returns number

autoSuggest

• autoSuggest(queryString: string, options?: SearchOptions): Suggestion[]

  Without a filter, aggregates suggestions from raw query hits (no full result materialization). With a filter, uses search so stored fields are available to the predicate.

  Parameters

  • queryString: string
  • options: SearchOptions = {}

  Returns Suggestion[]

getStoredFields

• getStoredFields(id: unknown): Record<string, unknown> | undefined

  Stored fields for a document id, when configured via Options.storeFields. Returns undefined if the id is missing or no fields were stored.

  Parameters

  • id: unknown

  Returns Record<string, unknown> | undefined

has

• has(id: unknown): boolean

  Whether a document with the given external id is in the index.

  Parameters

  • id: unknown

  Returns boolean

search

• search(query: Query, searchOptions?: SearchOptions): SearchResult[]

  Search the index. API and scoring match MiniSearch 7 for the same options.

  query may be a string, FrozenMiniSearchCore.wildcard, or a nested QueryCombination. Per-query options override index defaults from Options.searchOptions; see SearchOptions for boosts, prefix, fuzzy, filters, and combineWith.

  Parameters

  • query: Query
  • searchOptions: SearchOptions = {}

  Returns SearchResult[]

  Matches sorted by descending score.

toJSON

• toJSON(): MiniSearchSnapshot

  Export this index as a MiniSearch wire snapshot (serializationVersion: 2). Use for migration or interchange with the minisearch package (JSON.stringify works via this method). Term order in index may differ from MiniSearch native toJSON; search scores stay equivalent.

  Returns MiniSearchSnapshot

StaticfromAsyncIterable

• fromAsyncIterable<T, I extends FrozenMiniSearchCore<T>>(
      this: FrozenMiniSearchCtor<T, I>,
      iterable: AsyncIterable<T>,
      options: Options<T>,
      hints?: FrozenIndexBuilderHints,
  ): Promise<I>

  Build a read-only index from an async stream of documents (e.g. CSV parser). For sync iterables, use createFrozenIndexBuilder with for...of instead.

  Type Parameters

  • T
  • I extends FrozenMiniSearchCore<T>

  Parameters

  • this: FrozenMiniSearchCtor<T, I>
  • iterable: AsyncIterable<T>
  • options: Options<T>
  • Optionalhints: FrozenIndexBuilderHints

    Optional builder hints; estimatedDocumentCount pre-allocates per-document arrays when the final document count is known upfront.

  Returns Promise<I>

StaticfromDocuments

• fromDocuments<T, I extends FrozenMiniSearchCore<T>>(
      this: FrozenMiniSearchCtor<T, I>,
      documents: readonly T[],
      options: Options<T>,
  ): I

  Build a read-only index in one pass from an in-memory document array. Indexing semantics match MiniSearch addAll for the same Options.

  For custom ingestion (streaming, per-document transforms), use createFrozenIndexBuilder and freezeFrozenIndexBuilder instead. The named export buildFrozenFromDocuments is equivalent on the Node/browser entry.

  Type Parameters

  • T
  • I extends FrozenMiniSearchCore<T>

  Parameters

  • this: FrozenMiniSearchCtor<T, I>
  • documents: readonly T[]
  • options: Options<T>

  Returns I

StaticfromJSON

• fromJSON<T, I extends FrozenMiniSearchCore<T>>(
      this: FrozenMiniSearchCtor<T, I>,
      json: string,
      options?: Options<T>,
  ): I

  Build a new frozen index from a MiniSearch JSON snapshot string (import / migration). Accepts the wire format produced by MiniSearch toJSON or by toJSON on this class. No runtime dependency on the minisearch package.

  Type Parameters

  • T
  • I extends FrozenMiniSearchCore<T>

  Parameters

  • this: FrozenMiniSearchCtor<T, I>
  • json: string
  • options: Options<T> = ...

  Returns I

StaticgetDefault

• getDefault<
      K extends
          | "idField"
          | "extractField"
          | "stringifyField"
          | "tokenize"
          | "processTerm"
          | "storeFields",
  >(
      optionName: K,
  ): {
      extractField: (document: any, fieldName: string) => any;
      idField: string;
      processTerm: (term: string) => string;
      storeFields: string[];
      stringifyField: (fieldValue: any) => any;
      tokenize: (text: string) => string[];
  }[K]

  Built-in default for indexing / load options (tokenize, processTerm, extractField, …).

  Type Parameters

  • K extends
        | "idField"
        | "extractField"
        | "stringifyField"
        | "tokenize"
        | "processTerm"
        | "storeFields"

  Parameters

  • optionName: K

  Returns {
      extractField: (document: any, fieldName: string) => any;
      idField: string;
      processTerm: (term: string) => string;
      storeFields: string[];
      stringifyField: (fieldValue: any) => any;
      tokenize: (text: string) => string[];
  }[K]