minisearch - npm Package Compare versions

Comparing version 2.5.1 to 2.6.0

CHANGELOG.md

@@ -5,2 +5,7 @@ # Changelog
 
+# v2.6.0
+
+  - Better TypeScript typings using generics, letting the user (optionally)
+    specify the document type.
+
 # v2.5.1
@@ -7,0 +12,0 @@

package.json

 {
   "name": "minisearch",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "Tiny but powerful full-text search engine for browser and Node",
@@ -5,0 +5,0 @@ "main": "dist/umd/index.js",

README.md

@@ -71,3 +71,3 @@ # MiniSearch
 ```html
-<script src="https://cdn.jsdelivr.net/npm/minisearch@2.5.1/dist/umd/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/minisearch@2.6.0/dist/umd/index.min.js"></script>
 ```
@@ -74,0 +74,0 @@

src/index.d.ts

 // Type definitions for MiniSearch
 
-declare class MiniSearch {
-    constructor(options: Options);
+declare class MiniSearch<T = object> {
+    constructor(options: Options<T>);
 
     documentCount: number;
 
-    add(document: object): void;
+    add(document: T): void;
 
-    addAll(documents: object[]): void;
+    addAll(documents: T[]): void;
 
-    addAllAsync(documents: object[], options?: { chunkSize?: number }): Promise<undefined>;
+    addAllAsync(documents: T[], options?: { chunkSize?: number }): Promise<undefined>;
 
-    autoSuggest(query: string, options?: SearchOptions): Suggestion[];
+    autoSuggest(query: string, options?: SearchOptions<T>): Suggestion[];
 
-    remove(document: object): void;
+    remove(document: T): void;
 
-    removeAll(documents?: object[]): void;
+    removeAll(documents?: T[]): void;
 
-    search(query: string, options?: SearchOptions): SearchResult[];
+    search(query: string, options?: SearchOptions<T>): SearchResult[];
 
@@ -26,6 +26,6 @@ toJSON(): object;
 
-    static loadJSON(json: string, options: Options): MiniSearch;
+    static loadJSON<T = object>(json: string, options: Options<T>): MiniSearch<T>;
 }
 
-export declare interface SearchOptions {
+export declare interface SearchOptions<T = object> {
   fields?: string[],
@@ -45,3 +45,3 @@
 
-  extractField?: (document: object, fieldName: string) => string,
+  extractField?: (document: T, fieldName: string) => string,
 
@@ -53,3 +53,3 @@ tokenize?: (text: string) => string[],
 
-export declare interface Options {
+export declare interface Options<T = object> {
   fields: string[],
@@ -61,3 +61,3 @@
 
-  extractField?: (document: object, fieldName: string) => string,
+  extractField?: (document: T, fieldName: string) => string,
 
@@ -68,3 +68,3 @@ tokenize?: (text: string, fieldName: string) => string[],
 
-  searchOptions?: SearchOptions
+  searchOptions?: SearchOptions<T>
 }
@@ -71,0 +71,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

283846

increased by0.05%

No dependency changes