fix(typescript): clarify input to parseIndex

Narrowing the type of the parameter from `any` makes it obvious that the input is an `Object`, rather than a `String`. With the `any` type as input, it was not obvious how to use this function. See #524 and #624 for people bitten by this.
krisk · Feb 3, 2025 · 72b6e25 · 72b6e25
1 parent 4e30d3e
commit 72b6e25
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -91,7 +91,10 @@ declare class Fuse<T> {
   ): FuseIndex<U>
 
   public static parseIndex<U>(
-    index: any,
+    index: {
+      keys: ReadonlyArray<string>
+      records: FuseIndexRecords
+    },
     options?: FuseIndexOptions<U>
   ): FuseIndex<U>