cmpstr 2.0.0 → 2.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 CmpStr is a lightweight and powerful npm package for calculating string similarity, finding the closest matches in arrays, performing phonetic searches, and more. It supports a variety of built-in algorithms (e.g., Levenshtein, Dice-Sørensen, Damerau-Levenshtein, Soundex) and allows users to add custom algorithms and normalization filters.
 
-#### Key Features
+**Key Features**
 
 - Built-in support for multiple similarity algorithms.
 - Phonetic search with language-specific configurations (e.g., Soundex).
@@ -10,6 +10,7 @@ CmpStr is a lightweight and powerful npm package for calculating string similari
 - Customizable normalization with global flags and caching.
 - Asynchronous support for non-blocking workflows.
 - Extensible with custom algorithms and filters.
+- TypeScript definitions for better developer experience.
 
 ## Installation
 

package/package.json

@@ -7,8 +7,9 @@
     "url" : "https://komed3.de"
   },
   "homepage": "https://github.com/komed3/cmpstr#readme",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "license": "MIT",
   "keywords": [
     "string-similarity",
@@ -35,7 +36,8 @@
     "text-processing",
     "fuzzy-matching",
     "string-matching",
-    "text-similarity"
+    "text-similarity",
+    "typescript-definitions"
   ],
   "repository": {
     "type": "git",

package/src/CmpStr.d.ts

@@ -0,0 +1,64 @@
+export interface Config {
+    flags?: string;
+    threshold?: number;
+    options?: Record<string, any>;
+}
+
+export interface BatchResult {
+    target: string;
+    match: number | any;
+}
+
+export declare class CmpStr {
+
+    constructor ( algo?: string, str?: string );
+
+    isReady () : boolean;
+
+    setStr ( str: string ) : boolean;
+
+    listAlgo () : string[];
+
+    isAlgo ( algo: string ) : boolean;
+
+    setAlgo ( algo: string ) : boolean;
+
+    addAlgo ( algo: string, callback: (
+        a: string, b: string, ...args : any
+    ) => number | any, useIt?: boolean ) : boolean;
+
+    rmvAlgo( algo: string ) : boolean;
+
+    listFilter () : string[];
+
+    addFilter ( name: string, callback: (
+        str: string
+    ) => string, priority?: number ) : boolean;
+
+    rmvFilter ( name: string ) : boolean;
+
+    pauseFilter ( name: string ) : boolean;
+
+    resumeFilter ( name: string ) : boolean;
+
+    clearFilter () : boolean;
+
+    setFlags( flags: string ) : void;
+
+    normalize ( str: string, flags?: string ) : string;
+
+    clearCache () : boolean;
+
+    compare ( algo: string, a: string, b: string, config?: Config ) : number | any;
+
+    test ( str: string, config?: Config ) : number | any;
+
+    batchTest ( arr: string[], config?: Config ) : BatchResult[];
+
+    match ( arr: string[], config?: Config ) : BatchResult[];
+
+    closest ( arr: string[], config?: Config ) : string | undefined;
+
+    similarityMatrix ( algo: string, arr: string[], config?: Config ) : number[][];
+
+}

package/src/CmpStrAsync.d.ts

@@ -0,0 +1,17 @@
+import { CmpStr, Config, BatchResult } from './CmpStr';
+
+export declare class CmpStrAsync extends CmpStr {
+
+    compareAsync ( algo: string, a: string, b: string, config?: Config ) : Promise<number | any>;
+
+    testAsync ( str: string, config?: Config ) : Promise<number | any>;
+
+    batchTestAsync ( arr: string[], config?: Config ) : Promise<BatchResult[]>;
+
+    matchAsync ( arr: string[], config?: Config ) : Promise<BatchResult[]>;
+
+    closestAsync ( arr: string[], config?: Config ) : Promise<string | undefined>;
+
+    similarityMatrixAsync ( algo: string, arr: string[], config?: Config ) : Promise<number[][]>;
+
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export { CmpStr, Config, BatchResult } from './CmpStr';
+
+export { CmpStrAsync } from './CmpStrAsync';

package/src/index.js

@@ -22,7 +22,7 @@
  * - generate similarity matrices for cross-comparisons
  * 
  * @author Paul Köhler (komed3)
- * @version 2.0.0
+ * @version 2.0.1
  * @license MIT
  */