rapid-fuzzy 0.6.0 → 1.1.0

package/README.md

@@ -10,16 +10,18 @@
 
 Blazing-fast fuzzy search for JavaScript — powered by Rust, works everywhere.
 
-<img src=".github/assets/demo.svg" alt="rapid-fuzzy demo — fuzzy search, query syntax, FuzzyIndex, and string distance" width="580" />
-
 ## Features
 
-- **Fast**: Up to 7,000x faster than fuse.js with FuzzyIndex (Rust + napi-rs)
+- **Fast**: Up to 15,000x faster than fuse.js with FuzzyIndex (Rust + napi-rs)
 - **Universal**: Works in Node.js (native), browsers (WASM), Deno, and Bun
 - **Zero JS dependencies**: Pure Rust core with napi-rs bindings
 - **Type-safe**: Full TypeScript support with auto-generated type definitions
 - **Drop-in**: API compatible with popular fuzzy search libraries
 
+## Playground
+
+Try rapid-fuzzy in the browser — no installation required: **[Open Playground](https://derodero24.github.io/rapid-fuzzy/)**
+
 ## Quick Start
 
 ```typescript
@@ -29,7 +31,7 @@ const results = search('typscript', ['TypeScript', 'JavaScript', 'Python']);
 // → [{ item: 'TypeScript', score: 0.85, index: 0 }, ...]
 ```
 
-For repeated searches, use `FuzzyIndex` for up to 182x faster lookups:
+For repeated searches, use `FuzzyIndex` for up to 297x faster lookups:
 
 ```typescript
 import { FuzzyIndex } from 'rapid-fuzzy';
@@ -49,9 +51,16 @@ pnpm add rapid-fuzzy
 ### Runtime-specific notes
 
 - **Node.js** (>=20): Uses native bindings via napi-rs for best performance.
-- **Browser / Deno / Bun**: Falls back to a WASM build automatically.
+- **Browser / Deno / Bun**: Falls back to a WASM build automatically. The WASM binary is ~660 KB raw (~230 KB gzipped).
 
-> **Note**: rapid-fuzzy is pre-1.0 — the API is stable but minor versions may include additions.
+> **Browser WASM requirement**: The WASM build uses `SharedArrayBuffer` for threading, which requires the following HTTP headers on your page:
+> ```
+> Cross-Origin-Opener-Policy: same-origin
+> Cross-Origin-Embedder-Policy: require-corp
+> ```
+> Without these headers, you will see `SharedArrayBuffer is not defined`. See [MDN: SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements) for details.
+
+## API
 
 ### Fuzzy Search
 
@@ -70,9 +79,6 @@ const results = search('typscript', [
 // With options: filter by minimum score and limit results
 search('app', items, { maxResults: 5, minScore: 0.3 });
 
-// Backward compatible: pass a number for maxResults
-search('app', items, 5);
-
 // Get matched character positions for highlighting
 const [match] = search('hlo', ['hello world'], { includePositions: true });
 // → { item: 'hello world', score: 0.75, index: 0, positions: [0, 2, 4] }
@@ -80,6 +86,9 @@ const [match] = search('hlo', ['hello world'], { includePositions: true });
 // Case-sensitive matching (default: smart case)
 search('Type', items, { isCaseSensitive: true });
 
+// Return all items when query is empty (useful for filter-as-you-type UIs)
+search('', items, { returnAllOnEmpty: true });
+
 // Find the single best match
 closest('tsc', ['TypeScript', 'JavaScript', 'Python']);
 // → 'TypeScript'
@@ -92,11 +101,12 @@ closest('xyz', items, 0.5);
 ### String Distance
 
 ```typescript
-import { levenshtein, jaroWinkler, sorensenDice } from 'rapid-fuzzy';
+import { levenshtein, jaroWinkler, sorensenDice, hamming } from 'rapid-fuzzy';
 
 levenshtein('kitten', 'sitting');     // 3
 jaroWinkler('MARTHA', 'MARHTA');      // 0.961
 sorensenDice('night', 'nacht');       // 0.25
+hamming('karolin', 'kathrin');        // 3 (null if lengths differ)
 ```
 
 ### Query Syntax
@@ -153,12 +163,16 @@ For applications that search the same dataset repeatedly (autocomplete, file fin
 ```typescript
 import { FuzzyIndex, FuzzyObjectIndex } from 'rapid-fuzzy';
 
-// String search index — up to 182x faster than standalone search()
+// String search index — up to 297x faster than standalone search()
 const index = new FuzzyIndex(['TypeScript', 'JavaScript', 'Python', ...]);
 
 index.search('typscript', { maxResults: 5 });
 index.closest('tsc');
 
+// Index-only results (no string cloning — less GC pressure)
+const hits = index.searchIndices('typscript', { maxResults: 5 });
+// → [{ index: 0, score: 0.85, positions: [] }, ...]
+
 // Mutate the index without rebuilding
 index.add('Rust');
 index.remove(2); // swap-remove by index
@@ -200,7 +214,8 @@ highlightRanges(item, positions);
 // → [{ start: 0, end: 1, matched: true }, { start: 1, end: 2, matched: false }, ...]
 ```
 
-### Token-Based Matching
+<details>
+<summary><strong>Token-Based Matching</strong></summary>
 
 Order-independent and partial string matching, inspired by Python's [RapidFuzz](https://github.com/rapidfuzz/RapidFuzz):
 
@@ -227,7 +242,10 @@ weightedRatio('John Smith', 'Smith, John'); // 1.0
 
 All token-based functions include `Batch` and `Many` variants (e.g., `tokenSortRatioBatch`, `tokenSortRatioMany`).
 
-### Batch Operations
+</details>
+
+<details>
+<summary><strong>Batch Operations</strong></summary>
 
 All distance functions have `Batch` and `Many` variants that amortize FFI overhead:
 
@@ -245,15 +263,22 @@ levenshteinBatch([
 // Compare one string against many candidates
 levenshteinMany('kitten', ['sitting', 'kittens', 'kitchen']);
 // → [3, 1, 2]
+
+// With early-termination threshold (skip candidates that can't match)
+levenshteinMany('kitten', candidates, 3);        // maxDistance → returns 4 for exceeding
+jaroWinklerMany('MARTHA', candidates, 0.8);       // minSimilarity → returns 0.0 for below
 ```
 
 > **Tip**: Prefer batch/many variants over calling single-pair functions in a loop — they are significantly faster for multiple comparisons.
 
+</details>
+
 ## Choosing an Algorithm
 
 | Use case | Recommended | Why |
 |---|---|---|
 | Typo detection / spell check | `levenshtein`, `damerauLevenshtein` | Counts edits; Damerau adds transposition support |
+| Fixed-length comparison | `hamming` | Counts differing positions; only for equal-length strings |
 | Name / address matching | `jaroWinkler`, `tokenSortRatio` | Prefix-weighted or order-independent matching |
 | Document / text similarity | `sorensenDice` | Bigram-based; handles longer text well |
 | Normalized comparison (0–1) | `normalizedLevenshtein` | Length-independent similarity score |
@@ -261,11 +286,11 @@ levenshteinMany('kitten', ['sitting', 'kittens', 'kitchen']);
 | Substring / abbreviation matching | `partialRatio` | Finds best partial match within longer strings |
 | Best-effort similarity | `weightedRatio` | Picks the best score across all methods automatically |
 | Interactive fuzzy search | `search`, `closest` | Nucleo algorithm (same as Helix editor) |
-| Repeated search on same data | `FuzzyIndex`, `FuzzyObjectIndex` | Persistent Rust-side index with incremental cache, up to 182x faster |
+| Repeated search on same data | `FuzzyIndex`, `FuzzyObjectIndex` | Persistent Rust-side index with incremental cache, up to 297x faster |
 
 **Return types:**
 
-- `levenshtein`, `damerauLevenshtein` → integer (edit count)
+- `levenshtein`, `damerauLevenshtein`, `hamming` → integer (edit/difference count; `hamming` returns `null` if lengths differ)
 - `jaro`, `jaroWinkler`, `sorensenDice`, `normalizedLevenshtein` → float between 0.0 (no match) and 1.0 (identical)
 - `tokenSortRatio`, `tokenSetRatio`, `partialRatio`, `weightedRatio` → float between 0.0 and 1.0
 - `search` → array of `{ item, score, index, positions }` sorted by relevance (score: 0.0–1.0)
@@ -283,15 +308,16 @@ Measured on Apple M-series with Node.js v22 using [Vitest bench](https://vitest.
 
 | Function | rapid-fuzzy | fastest-levenshtein | leven | string-similarity |
 |---|---:|---:|---:|---:|
-| Levenshtein | 562,063 ops/s | **794,298 ops/s** | 228,688 ops/s | — |
-| Normalized Levenshtein | **546,107 ops/s** | — | — | — |
-| Sorensen-Dice | **147,850 ops/s** | — | — | 84,308 ops/s |
-| Jaro-Winkler | **293,403 ops/s** | — | — | — |
-| Damerau-Levenshtein | **116,153 ops/s** | — | — | — |
+| Levenshtein | 545,338 ops/s | **741,195 ops/s** | 225,457 ops/s | — |
+| Normalized Levenshtein | **514,446 ops/s** | — | — | — |
+| Sorensen-Dice | **142,180 ops/s** | — | — | 56,729 ops/s |
+| Jaro-Winkler | **505,762 ops/s** | — | — | — |
+| Damerau-Levenshtein | **116,186 ops/s** | — | — | — |
+| Hamming | **883,614 ops/s** | — | — | — |
 
 </details>
 
-> **Note**: For single-pair Levenshtein, fastest-levenshtein is ~1.4x faster due to its optimized pure-JS implementation that avoids FFI overhead. rapid-fuzzy is **2.5x faster** than leven, and provides broader algorithm coverage plus batch / search scenarios.
+> **Note**: For single-pair Levenshtein, fastest-levenshtein is ~1.4x faster due to its optimized pure-JS implementation that avoids FFI overhead. rapid-fuzzy is **2.4x faster** than leven, and provides broader algorithm coverage plus batch / search scenarios.
 
 ### Search Performance
 
@@ -304,10 +330,9 @@ Measured on Apple M-series with Node.js v22 using [Vitest bench](https://vitest.
 
 | Dataset size | rapid-fuzzy | rapid-fuzzy (indexed) | fuse.js | fuzzysort | uFuzzy |
 |---|---:|---:|---:|---:|---:|
-| Small (20 items) | 303,982 ops/s | 405,604 ops/s | 105,568 ops/s | **2,606,394 ops/s** | 923,069 ops/s |
-| Medium (1K items) | 6,787 ops/s | **80,579 ops/s** | 367 ops/s | 64,372 ops/s | 28,953 ops/s |
-| Large (10K items) | 751 ops/s | **136,528 ops/s** | 19 ops/s | 26,112 ops/s | 6,393 ops/s |
-| XL (50K items) | — | **31,903 ops/s** | — | 5,916 ops/s | 1,292 ops/s |
+| Small (20 items) | 279,509 ops/s | 395,932 ops/s | 118,443 ops/s | **1,661,273 ops/s** | 422,032 ops/s |
+| Medium (1K items) | 6,274 ops/s | **77,271 ops/s** | 358 ops/s | 58,123 ops/s | 26,052 ops/s |
+| Large (10K items) | 777 ops/s | **230,848 ops/s** | 15 ops/s | 25,315 ops/s | 4,663 ops/s |
 
 </details>
 
@@ -315,31 +340,22 @@ Measured on Apple M-series with Node.js v22 using [Vitest bench](https://vitest.
 
 | Dataset size | rapid-fuzzy | rapid-fuzzy (indexed) | fastest-levenshtein |
 |---|---:|---:|---:|
-| Medium (1K items) | 8,611 ops/s | **989,095 ops/s** | 6,797 ops/s |
-| Large (10K items) | 924 ops/s | **156,014 ops/s** | 658 ops/s |
+| Medium (1K items) | 7,690 ops/s | **906,274 ops/s** | 3,536 ops/s |
+| Large (10K items) | 611 ops/s | **352,688 ops/s** | 620 ops/s |
 
-> In indexed mode (`FuzzyIndex`), rapid-fuzzy is up to **237x faster** than fastest-levenshtein for closest-match lookups.
+> In indexed mode (`FuzzyIndex`), rapid-fuzzy is up to **569x faster** than fastest-levenshtein for closest-match lookups.
 
-### Why these numbers matter
+### Key takeaways
 
-- **vs fuse.js**: `FuzzyIndex` is **219x faster** on medium datasets and **6,869x faster** on large datasets. Even standalone `search()` is 18x / 40x faster.
-- **Indexed mode**: `FuzzyIndex` keeps data on the Rust side with an incremental search cache, delivering sub-millisecond autocomplete. On large datasets this is **182x faster** than standalone `search()`.
-- **vs fuzzysort**: `FuzzyIndex` now **outperforms fuzzysort** on medium-and-above datasets — 1.25x faster at 1K, 5.2x at 10K, and 5.4x at 50K.
-- **vs uFuzzy**: `FuzzyIndex` is **2.8x faster** at medium and **21x faster** at large datasets.
-- **vs fastest-levenshtein**: With `FuzzyIndex`, closest-match is **145x faster** at 1K and **237x faster** at 10K.
-
-Run benchmarks yourself:
-
-```bash
-pnpm run bench        # JavaScript benchmarks
-cargo bench           # Rust internal benchmarks
-```
+- **vs fuse.js**: `FuzzyIndex` is **216x–15,390x faster** depending on dataset size. Even standalone `search()` is 18–52x faster.
+- **Indexed mode**: `FuzzyIndex` keeps data on the Rust side with incremental caching — **297x faster** than standalone `search()` on large datasets, delivering sub-millisecond autocomplete.
+- **vs fuzzysort / uFuzzy**: `FuzzyIndex` outperforms both on 1K+ datasets (up to 9.1x vs fuzzysort, 50x vs uFuzzy).
 
 ## Why rapid-fuzzy?
 
 | | rapid-fuzzy | fuse.js | fastest-levenshtein | fuzzysort | uFuzzy |
 |---|:---:|:---:|:---:|:---:|:---:|
-| **Algorithms** | 9 (Levenshtein, Jaro, Dice, …) | Bitap | Levenshtein | Substring | Regex-based |
+| **Algorithms** | 10 (Levenshtein, Hamming, Jaro, Dice, …) | Bitap | Levenshtein | Substring | Regex-based |
 | **Runtime** | Rust native + WASM | Pure JS | Pure JS | Pure JS | Pure JS |
 | **Object search** | ✅ weighted keys | ✅ | — | ✅ | — |
 | **Persistent index** | ✅ FuzzyIndex / FuzzyObjectIndex | — | — | ✅ prepared targets | — |
@@ -351,7 +367,7 @@ cargo bench           # Rust internal benchmarks
 | **Highlight utility** | ✅ | — | — | ✅ | ✅ |
 | **Batch API** | ✅ | — | — | — | — |
 | **Node.js native** | ✅ napi-rs | — | — | — | — |
-| **Browser** | ✅ WASM | ✅ | ✅ | ✅ | ✅ |
+| **Browser** | ✅ WASM (~230 KB gzipped) | ✅ | ✅ | ✅ | ✅ |
 | **TypeScript** | ✅ full | ✅ full | ✅ | ✅ | ✅ |
 
 ## Migration Guides
@@ -359,9 +375,9 @@ cargo bench           # Rust internal benchmarks
 Switching from another library? These guides provide API mapping tables, code examples, and performance comparisons:
 
 - [**From string-similarity**](docs/migration/from-string-similarity.md) — Same Dice coefficient algorithm, now maintained and faster
-- [**From fuse.js**](docs/migration/from-fuse-js.md) — Up to 7,000x faster fuzzy search with FuzzyIndex
+- [**From fuse.js**](docs/migration/from-fuse-js.md) — Up to 15,000x faster fuzzy search with FuzzyIndex
 - [**From leven / fastest-levenshtein**](docs/migration/from-leven.md) — Multi-algorithm upgrade with batch APIs
-- [**From fuzzysort**](docs/migration/from-fuzzysort.md) — Richer matching with query syntax and 9 distance algorithms
+- [**From fuzzysort**](docs/migration/from-fuzzysort.md) — Richer matching with query syntax and 10 distance algorithms
 - [**From uFuzzy**](docs/migration/from-ufuzzy.md) — Weighted object search, batch APIs, and persistent indexes
 
 ## License

package/index.d.ts

@@ -29,6 +29,14 @@ export declare class FuzzyIndex {
    * If minScore is provided, returns null when the best match scores below the threshold.
    */
   closest(query: string, minScore?: number | undefined | null): string | null
+  /**
+   * Search the index, returning only indices and scores (no item strings).
+   *
+   * This is more efficient than `search()` when you maintain your own data
+   * array and only need the index to look up the original item. Avoids
+   * String cloning overhead for each result.
+   */
+  searchIndices(query: string, options?: number | SearchOptions | undefined | null): Array<IndexSearchResult>
   /** Add a single item to the index. */
   add(item: string): void
   /** Add multiple items to the index at once. */
@@ -41,6 +49,21 @@ export declare class FuzzyIndex {
   remove(index: number): boolean
   /** Free the internal data. After calling this, the index is empty. */
   destroy(): void
+  /**
+   * Serialize the index to a compact binary format.
+   *
+   * The returned Buffer can be written to disk, stored in IndexedDB,
+   * or transferred over the network. Use `FuzzyIndex.deserialize()` to
+   * reconstruct the index.
+   */
+  serialize(): Buffer
+  /**
+   * Reconstruct a FuzzyIndex from a previously serialized Buffer.
+   *
+   * Pre-computes Utf32String and character masks from the stored items,
+   * so the returned index is immediately ready for searching.
+   */
+  static deserialize(data: Buffer): FuzzyIndex
 }
 
 /**
@@ -75,12 +98,14 @@ export declare class KeyedFuzzyIndex {
    * Add a single item to the index.
    *
    * `key_values` must have the same length as the number of keys.
+   * Throws if the length does not match.
    */
   add(keyValues: Array<string>): void
   /**
    * Add multiple items to the index at once.
    *
    * Each element of `items_key_values` is an array of key values for one item.
+   * Throws if any element has the wrong number of key values.
    */
   addMany(itemsKeyValues: Array<Array<string>>): void
   /**
@@ -120,8 +145,62 @@ export declare function damerauLevenshteinBatch(pairs: Array<Array<string>>): Ar
  * Compute the Damerau-Levenshtein distance from one reference string to many candidates.
  *
  * Returns an array of distances, one per candidate, in the same order as the input.
+ * If `max_distance` is provided, candidates with distance exceeding the threshold
+ * will return `max_distance + 1` (enabling early termination for better performance).
+ */
+export declare function damerauLevenshteinMany(reference: string, candidates: Array<string>, maxDistance?: number | undefined | null): Array<number>
+
+/**
+ * Compute the Hamming distance between two strings.
+ *
+ * The Hamming distance counts the number of positions at which the corresponding
+ * characters differ. It is only defined for strings of equal length.
+ * Returns `null` if the strings have different lengths.
  */
-export declare function damerauLevenshteinMany(reference: string, candidates: Array<string>): Array<number>
+export declare function hamming(a: string, b: string): number | null
+
+/**
+ * Compute the Hamming distance for multiple pairs of strings in a single call.
+ *
+ * Returns an array of distances in the same order as the input pairs.
+ * Each pair must be an array of exactly two strings `[a, b]`.
+ * Returns `null` for pairs with different lengths.
+ */
+export declare function hammingBatch(pairs: Array<Array<string>>): Array<number | undefined | null>
+
+/**
+ * Compute the Hamming distance from one reference string to many candidates.
+ *
+ * Returns an array of distances, one per candidate, in the same order as the input.
+ * Returns `null` for candidates with a different length than the reference.
+ * If `max_distance` is provided, candidates with distance exceeding the threshold
+ * will also return `null` (enabling early termination for better performance).
+ */
+export declare function hammingMany(reference: string, candidates: Array<string>, maxDistance?: number | undefined | null): Array<number | undefined | null>
+
+/**
+ * A lightweight search result containing only index and score (no item string).
+ *
+ * Use this when you maintain your own data array and only need the index
+ * to look up the original item. Avoids String cloning overhead.
+ */
+export interface IndexSearchResult {
+  /** The index of the item in the original input array. */
+  index: number
+  /** The match score normalized to 0.0-1.0 range (1.0 is a perfect match). */
+  score: number
+  /**
+   * Indices of matched characters in the item string.
+   * Empty unless `includePositions` is set to true in SearchOptions.
+   */
+  positions: Array<number>
+  /**
+   * How the query matched this item (Exact, Prefix, Contains, or Fuzzy).
+   * Only present when `includePositions` is set to true in SearchOptions.
+   * Derived from positions at zero additional cost.
+   */
+  matchType?: MatchType
+}
 
 /**
  * Compute the Jaro similarity between two strings.
@@ -141,8 +220,10 @@ export declare function jaroBatch(pairs: Array<Array<string>>): Array<number>
  * Compute the Jaro similarity from one reference string to many candidates.
  *
  * Returns an array of similarity scores, one per candidate, in the same order as the input.
+ * If `min_similarity` is provided, candidates with similarity below the threshold
+ * will return `0.0` (enabling early termination for better performance).
  */
-export declare function jaroMany(reference: string, candidates: Array<string>): Array<number>
+export declare function jaroMany(reference: string, candidates: Array<string>, minSimilarity?: number | undefined | null): Array<number>
 
 /**
  * Compute the Jaro-Winkler similarity between two strings.
@@ -163,8 +244,10 @@ export declare function jaroWinklerBatch(pairs: Array<Array<string>>): Array<num
  * Compute the Jaro-Winkler similarity from one reference string to many candidates.
  *
  * Returns an array of similarity scores, one per candidate, in the same order as the input.
+ * If `min_similarity` is provided, candidates with similarity below the threshold
+ * will return `0.0` (enabling early termination for better performance).
  */
-export declare function jaroWinklerMany(reference: string, candidates: Array<string>): Array<number>
+export declare function jaroWinklerMany(reference: string, candidates: Array<string>, minSimilarity?: number | undefined | null): Array<number>
 
 /** A single result from multi-key fuzzy search. */
 export interface KeySearchResult {
@@ -200,8 +283,26 @@ export declare function levenshteinBatch(pairs: Array<Array<string>>): Array<num
  * Compute the Levenshtein distance from one reference string to many candidates.
  *
  * Returns an array of distances, one per candidate, in the same order as the input.
+ * If `max_distance` is provided, candidates with distance exceeding the threshold
+ * will return `max_distance + 1` (enabling early termination for better performance).
+ */
+export declare function levenshteinMany(reference: string, candidates: Array<string>, maxDistance?: number | undefined | null): Array<number>
+
+/**
+ * Classification of how a query matched an item.
+ *
+ * Derived from the matched character positions:
+ * - **Exact**: all positions consecutive from index 0, covering every character in the item.
+ * - **Prefix**: all positions consecutive from index 0, but the item is longer.
+ * - **Contains**: all positions consecutive (a substring match), not starting at 0.
+ * - **Fuzzy**: positions have gaps (character-level fuzzy match).
  */
-export declare function levenshteinMany(reference: string, candidates: Array<string>): Array<number>
+export declare const enum MatchType {
+  Exact = 'Exact',
+  Prefix = 'Prefix',
+  Contains = 'Contains',
+  Fuzzy = 'Fuzzy'
+}
 
 /**
  * Compute the normalized Levenshtein similarity between two strings.
@@ -221,8 +322,10 @@ export declare function normalizedLevenshteinBatch(pairs: Array<Array<string>>):
  * Compute the normalized Levenshtein similarity from one reference string to many candidates.
  *
  * Returns an array of similarity scores, one per candidate, in the same order as the input.
+ * If `min_similarity` is provided, candidates with similarity below the threshold
+ * will return `0.0` (enabling early termination for better performance).
  */
-export declare function normalizedLevenshteinMany(reference: string, candidates: Array<string>): Array<number>
+export declare function normalizedLevenshteinMany(reference: string, candidates: Array<string>, minSimilarity?: number | undefined | null): Array<number>
 
 /**
  * Compute the partial ratio between two strings.
@@ -285,6 +388,12 @@ export interface SearchOptions {
    * (case-insensitive unless the query contains uppercase characters).
    */
   isCaseSensitive?: boolean
+  /**
+   * If true, return all items when the query is empty (or whitespace-only).
+   * Useful for filter-as-you-type UIs where the full list should appear
+   * before the user starts typing. Default is false.
+   */
+  returnAllOnEmpty?: boolean
 }
 
 /** A single fuzzy search result with the matched item and its score. */
@@ -300,6 +409,12 @@ export interface SearchResult {
    * Empty unless `includePositions` is set to true in SearchOptions.
    */
   positions: Array<number>
+  /**
+   * How the query matched this item (Exact, Prefix, Contains, or Fuzzy).
+   * Only present when `includePositions` is set to true in SearchOptions.
+   * Derived from positions at zero additional cost.
+   */
+  matchType?: MatchType
 }
 
 /**

package/index.js

@@ -77,8 +77,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-android-arm64')
         const bindingPackageVersion = require('rapid-fuzzy-android-arm64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-android-arm-eabi')
         const bindingPackageVersion = require('rapid-fuzzy-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-win32-x64-gnu')
         const bindingPackageVersion = require('rapid-fuzzy-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-win32-x64-msvc')
         const bindingPackageVersion = require('rapid-fuzzy-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-win32-ia32-msvc')
         const bindingPackageVersion = require('rapid-fuzzy-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-win32-arm64-msvc')
         const bindingPackageVersion = require('rapid-fuzzy-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
     try {
       const binding = require('rapid-fuzzy-darwin-universal')
       const bindingPackageVersion = require('rapid-fuzzy-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-darwin-x64')
         const bindingPackageVersion = require('rapid-fuzzy-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-darwin-arm64')
         const bindingPackageVersion = require('rapid-fuzzy-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-freebsd-x64')
         const bindingPackageVersion = require('rapid-fuzzy-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-freebsd-arm64')
         const bindingPackageVersion = require('rapid-fuzzy-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-x64-musl')
           const bindingPackageVersion = require('rapid-fuzzy-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-x64-gnu')
           const bindingPackageVersion = require('rapid-fuzzy-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-arm64-musl')
           const bindingPackageVersion = require('rapid-fuzzy-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-arm64-gnu')
           const bindingPackageVersion = require('rapid-fuzzy-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-arm-musleabihf')
           const bindingPackageVersion = require('rapid-fuzzy-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-arm-gnueabihf')
           const bindingPackageVersion = require('rapid-fuzzy-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-loong64-musl')
           const bindingPackageVersion = require('rapid-fuzzy-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-loong64-gnu')
           const bindingPackageVersion = require('rapid-fuzzy-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-riscv64-musl')
           const bindingPackageVersion = require('rapid-fuzzy-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
         try {
           const binding = require('rapid-fuzzy-linux-riscv64-gnu')
           const bindingPackageVersion = require('rapid-fuzzy-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-linux-ppc64-gnu')
         const bindingPackageVersion = require('rapid-fuzzy-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-linux-s390x-gnu')
         const bindingPackageVersion = require('rapid-fuzzy-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-openharmony-arm64')
         const bindingPackageVersion = require('rapid-fuzzy-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-openharmony-x64')
         const bindingPackageVersion = require('rapid-fuzzy-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
       try {
         const binding = require('rapid-fuzzy-openharmony-arm')
         const bindingPackageVersion = require('rapid-fuzzy-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '0.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '1.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 1.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -582,6 +582,9 @@ module.exports.closest = nativeBinding.closest
 module.exports.damerauLevenshtein = nativeBinding.damerauLevenshtein
 module.exports.damerauLevenshteinBatch = nativeBinding.damerauLevenshteinBatch
 module.exports.damerauLevenshteinMany = nativeBinding.damerauLevenshteinMany
+module.exports.hamming = nativeBinding.hamming
+module.exports.hammingBatch = nativeBinding.hammingBatch
+module.exports.hammingMany = nativeBinding.hammingMany
 module.exports.jaro = nativeBinding.jaro
 module.exports.jaroBatch = nativeBinding.jaroBatch
 module.exports.jaroMany = nativeBinding.jaroMany
@@ -591,6 +594,7 @@ module.exports.jaroWinklerMany = nativeBinding.jaroWinklerMany
 module.exports.levenshtein = nativeBinding.levenshtein
 module.exports.levenshteinBatch = nativeBinding.levenshteinBatch
 module.exports.levenshteinMany = nativeBinding.levenshteinMany
+module.exports.MatchType = nativeBinding.MatchType
 module.exports.normalizedLevenshtein = nativeBinding.normalizedLevenshtein
 module.exports.normalizedLevenshteinBatch = nativeBinding.normalizedLevenshteinBatch
 module.exports.normalizedLevenshteinMany = nativeBinding.normalizedLevenshteinMany

package/index.mjs

@@ -5,11 +5,16 @@ const binding = require('./index.js');
 
 export const {
   FuzzyIndex,
+  KeyedFuzzyIndex,
+  MatchType,
   closest,
   searchKeys,
   damerauLevenshtein,
   damerauLevenshteinBatch,
   damerauLevenshteinMany,
+  hamming,
+  hammingBatch,
+  hammingMany,
   jaro,
   jaroBatch,
   jaroMany,

package/objects.d.ts

@@ -5,6 +5,10 @@ export interface KeyConfig {
   weight?: number;
 }
 
+/**
+ * Options for searchObjects(). Extends SearchOptions with key configuration.
+ * Note: `includePositions` has no effect for multi-key search.
+ */
 export interface ObjectSearchOptions extends SearchOptions {
   keys: Array<string | KeyConfig>;
 }
@@ -14,11 +18,6 @@ export interface ObjectSearchResult<T> {
   index: number;
   score: number;
   keyScores: Array<number>;
-  /**
-   * Indices of matched characters in the best-matching key string.
-   * Empty unless `includePositions` is set to true in ObjectSearchOptions.
-   */
-  positions: Array<number>;
 }
 
 /**
@@ -54,6 +53,7 @@ export interface ObjectIndexSearchOptions {
   maxResults?: number;
   minScore?: number;
   isCaseSensitive?: boolean;
+  returnAllOnEmpty?: boolean;
 }
 
 /**
@@ -82,10 +82,7 @@ export declare class FuzzyObjectIndex<T> {
   get size(): number;
 
   /** Search for objects matching the query. */
-  search(
-    query: string,
-    options?: ObjectIndexSearchOptions,
-  ): Array<Omit<ObjectSearchResult<T>, 'positions'>>;
+  search(query: string, options?: ObjectIndexSearchOptions): Array<ObjectSearchResult<T>>;
 
   /** Find the closest matching object, or null if no match. */
   closest(query: string, minScore?: number): T | null;

package/objects.js

@@ -31,9 +31,12 @@ function getNestedValue(obj, path) {
  * @param {number} [options.maxResults] - Maximum results to return.
  * @param {number} [options.minScore] - Minimum score threshold.
  * @param {boolean} [options.isCaseSensitive] - Enable case-sensitive matching.
- * @returns {Array<{ item: T; index: number; score: number; keyScores: number[]; positions: number[] }>}
+ * @returns {Array<{ item: T; index: number; score: number; keyScores: number[] }>}
  */
 function searchObjects(query, items, options) {
+  if (!options?.keys?.length) {
+    throw new TypeError('options.keys must be a non-empty array');
+  }
   const { keys, ...searchOpts } = options;
 
   const normalizedKeys = keys.map((k) =>
@@ -52,7 +55,6 @@ function searchObjects(query, items, options) {
     index: r.index,
     score: r.score,
     keyScores: r.keyScores,
-    positions: r.positions ?? [],
   }));
 }
 
@@ -78,6 +80,9 @@ class FuzzyObjectIndex {
    * @param {Array<string | { name: string; weight?: number }>} options.keys - Keys to search.
    */
   constructor(items, options) {
+    if (!options?.keys?.length) {
+      throw new TypeError('options.keys must be a non-empty array');
+    }
     this.#keys = options.keys.map((k) =>
       typeof k === 'string' ? { name: k, weight: 1.0 } : { name: k.name, weight: k.weight ?? 1.0 },
     );

package/objects.mjs

@@ -0,0 +1,2 @@
+// ESM re-export — single source of truth is objects.js (CJS).
+export { FuzzyObjectIndex, searchObjects } from './objects.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rapid-fuzzy",
-  "version": "0.6.0",
+  "version": "1.1.0",
   "description": "Rust-powered fuzzy search and string distance for JavaScript/TypeScript. 10-50x faster than fuse.js/leven.",
   "license": "MIT",
   "author": "derodero24",
@@ -12,11 +12,15 @@
   "keywords": [
     "fuzzy",
     "fuzzy-search",
+    "fuzzy-matching",
     "string-distance",
+    "string-similarity",
     "levenshtein",
     "jaro-winkler",
+    "hamming",
+    "damerau-levenshtein",
     "rust",
-    "napi",
+    "napi-rs",
     "wasm",
     "typescript",
     "search",
@@ -39,6 +43,26 @@
         "default": "./index.js"
       },
       "browser": "./browser.js"
+    },
+    "./highlight": {
+      "import": {
+        "types": "./highlight.d.ts",
+        "default": "./highlight.mjs"
+      },
+      "require": {
+        "types": "./highlight.d.ts",
+        "default": "./highlight.js"
+      }
+    },
+    "./objects": {
+      "import": {
+        "types": "./objects.d.ts",
+        "default": "./objects.mjs"
+      },
+      "require": {
+        "types": "./objects.d.ts",
+        "default": "./objects.js"
+      }
     }
   },
   "files": [
@@ -47,6 +71,7 @@
     "index.d.ts",
     "index.d.mts",
     "objects.js",
+    "objects.mjs",
     "objects.d.ts",
     "browser.js",
     "highlight.js",
@@ -76,6 +101,8 @@
     "postbuild": "node scripts/patch-binding.js",
     "build:debug": "napi build --manifest-path crates/core/Cargo.toml --platform --js index.js --dts index.d.ts --output-dir .",
     "build:wasm": "napi build --manifest-path crates/core/Cargo.toml --platform --release --js index.js --dts index.d.ts --output-dir . --target wasm32-wasip1-threads",
+    "postbuild:wasm": "node scripts/optimize-wasm.js",
+    "optimize:wasm": "node scripts/optimize-wasm.js",
     "artifacts": "napi artifacts",
     "prepublishOnly": "napi prepublish -t npm",
     "version": "napi version",
@@ -100,13 +127,13 @@
     "prepare": "lefthook install"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.4.6",
+    "@biomejs/biome": "^2.4.8",
     "@changesets/cli": "^2.30.0",
     "@codspeed/vitest-plugin": "^5.2.0",
-    "@commitlint/cli": "^20.4.4",
-    "@commitlint/config-conventional": "^20.4.4",
-    "@emnapi/core": "^1.9.0",
-    "@emnapi/runtime": "^1.9.0",
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
+    "@emnapi/core": "^1.9.1",
+    "@emnapi/runtime": "^1.9.1",
     "@leeoniya/ufuzzy": "^1.0.19",
     "@napi-rs/cli": "^3.5.1",
     "@napi-rs/wasm-runtime": "^1.1.1",
@@ -116,10 +143,13 @@
     "@types/string-similarity": "^4.0.2",
     "@vitest/coverage-v8": "^4.1.0",
     "fastest-levenshtein": "^1.0.16",
+    "flexsearch": "^0.8.212",
     "fuse.js": "^7.1.0",
+    "fuzzball": "^2.2.3",
     "fuzzysort": "^3.1.0",
     "lefthook": "^2.1.4",
     "leven": "^4.1.0",
+    "minisearch": "^7.2.0",
     "publint": "^0.3.18",
     "string-similarity": "^4.0.4",
     "typescript": "^5.9.3",
@@ -129,17 +159,22 @@
   "pnpm": {
     "onlyBuiltDependencies": [
       "lefthook"
-    ]
+    ],
+    "peerDependencyRules": {
+      "allowedVersions": {
+        "@codspeed/vitest-plugin>vite": "8"
+      }
+    }
   },
   "optionalDependencies": {
-    "rapid-fuzzy-darwin-x64": "0.6.0",
-    "rapid-fuzzy-darwin-arm64": "0.6.0",
-    "rapid-fuzzy-linux-x64-gnu": "0.6.0",
-    "rapid-fuzzy-linux-x64-musl": "0.6.0",
-    "rapid-fuzzy-linux-arm64-gnu": "0.6.0",
-    "rapid-fuzzy-linux-arm64-musl": "0.6.0",
-    "rapid-fuzzy-win32-x64-msvc": "0.6.0",
-    "rapid-fuzzy-win32-arm64-msvc": "0.6.0",
-    "rapid-fuzzy-wasm32-wasi": "0.6.0"
+    "rapid-fuzzy-darwin-x64": "1.1.0",
+    "rapid-fuzzy-darwin-arm64": "1.1.0",
+    "rapid-fuzzy-linux-x64-gnu": "1.1.0",
+    "rapid-fuzzy-linux-x64-musl": "1.1.0",
+    "rapid-fuzzy-linux-arm64-gnu": "1.1.0",
+    "rapid-fuzzy-linux-arm64-musl": "1.1.0",
+    "rapid-fuzzy-win32-x64-msvc": "1.1.0",
+    "rapid-fuzzy-win32-arm64-msvc": "1.1.0",
+    "rapid-fuzzy-wasm32-wasi": "1.1.0"
   }
 }