@yoch/frozenminisearch 1.1.0 → 1.2.1

package/dist/es/index.d.ts

@@ -113,7 +113,7 @@ type SearchOptionsWithDefaults = SearchOptions & {
     bm25: BM25Params;
 };
 /**
- * Configuration options passed to the {@link MiniSearch} constructor.
+ * Configuration options compatible with the MiniSearch constructor.
  *
  * @typeParam T  The type of documents being indexed.
  */
@@ -134,7 +134,7 @@ type Options<T = any> = {
     processTerm?: (term: string, fieldName?: string) => string | string[] | null | undefined | false;
     /** Function called to log messages from the library. */
     logger?: (level: LogLevel, message: string, code?: string) => void;
-    /** Auto-vacuum behaviour after {@link MiniSearch.discard}; defaults to `true`. */
+    /** Auto-vacuum behaviour after MiniSearch `discard`; defaults to `true`. */
     autoVacuum?: boolean | AutoVacuumOptions;
     /** Default search options. */
     searchOptions?: SearchOptions;
@@ -158,6 +158,20 @@ type OptionsWithDefaults<T = any> = Options<T> & {
     searchOptions: SearchOptionsWithDefaults;
     autoSuggestOptions: SearchOptions;
 };
+/** Compression codec selection for frozen binary snapshots. */
+type BinaryCompression = 'auto' | 'raw' | 'zstd' | 'zlib';
+/** Options for `saveBinarySync()` / `saveBinaryAsync()`. */
+type SaveBinaryOptions = {
+    /**
+     * Compression codec for the payload.
+     * - `auto`: one pass; payloads under 64 B stay raw; otherwise zstd when available
+     *   (else zlib on Node < 22.15), kept only when strictly smaller than raw
+     * - `raw`: never compress
+     * - `zstd`: always zstd-compress, even when larger than raw; requires Node 22.15+ to write
+     * - `zlib`: always deflate, even when larger than raw; readable on Node 20+
+     */
+    compression?: BinaryCompression;
+};
 /**
  * A search-completion suggestion.
  */
@@ -586,6 +600,7 @@ declare class FrozenMiniSearch<T = any> {
     private readonly _fieldTermFlyweight;
     private readonly _aggregateContext;
     private readonly _queryEngineParams;
+    private readonly _hasStoredFields;
     constructor(params: FrozenAssembleParams<T>);
     static readonly wildcard: typeof WILDCARD_QUERY;
     get documentCount(): number;
@@ -596,12 +611,12 @@ declare class FrozenMiniSearch<T = any> {
     search(query: Query, searchOptions?: SearchOptions): SearchResult[];
     autoSuggest(queryString: string, options?: SearchOptions): Suggestion[];
     /** Serialize this index as a frozen binary snapshot (synchronous). */
-    saveBinarySync(): Buffer;
-    /** Non-blocking zstd compression; same output as {@link saveBinarySync}. */
-    saveBinaryAsync(): Promise<Buffer>;
+    saveBinarySync(saveOptions?: SaveBinaryOptions): Buffer;
+    /** Non-blocking snapshot serialization with the selected compression codec. */
+    saveBinaryAsync(saveOptions?: SaveBinaryOptions): Promise<Buffer>;
     /** Load a frozen binary snapshot. */
     static loadBinarySync<T>(buffer: Buffer, options?: Options<T>): FrozenMiniSearch<T>;
-    /** Load a frozen binary snapshot with streaming zstd decompression (bounded memory). */
+    /** Load a frozen binary snapshot with streaming decompression when needed (bounded memory). */
     static loadBinaryAsync<T>(buffer: Buffer, options?: Options<T>): Promise<FrozenMiniSearch<T>>;
     private static fromBinarySnapshot;
     /** Build a read-only index in one pass from documents. */
@@ -643,4 +658,4 @@ declare class FrozenMiniSearch<T = any> {
 }
 
 export { AND, AND_NOT, FrozenIndexBuilder, FrozenMiniSearch, OR, assembleFrozen, buildFrozenFromDocuments, createFrozenIndexBuilder, FrozenMiniSearch as default, freezeFrozenIndexBuilder, frozenMemoryBreakdown };
-export type { BM25Params, CombinationOperator, FrozenAssembleParams, FrozenIndexBuilderHints, FrozenMemoryBreakdown, LogLevel, LowercaseCombinationOperator, MatchInfo, MiniSearchSnapshot, Options, Query, QueryCombination, SearchOptions, SearchResult, SerializedIndexEntry, Suggestion, Wildcard };
+export type { BM25Params, BinaryCompression, CombinationOperator, FrozenAssembleParams, FrozenIndexBuilderHints, FrozenMemoryBreakdown, LogLevel, LowercaseCombinationOperator, MatchInfo, MiniSearchSnapshot, Options, Query, QueryCombination, SaveBinaryOptions, SearchOptions, SearchResult, SerializedIndexEntry, Suggestion, Wildcard };