cmpstr 2.0.2 → 2.0.3

package/README.md

@@ -84,7 +84,7 @@ Clears the normalization cache.
 
 #### `listAlgo( [ loadedOnly = false ] )`
 
-List all registered similarity algorithms.
+List all registered or loaded similarity algorithms.
 
 Parameters:
 
@@ -145,9 +145,13 @@ Parameters:
 
 ### Filters
 
-#### `listFilter()`
+#### `listFilter( [ activeOnly = false ] )`
 
-List all added filters.
+List all added or active filter names. 
+
+Parameters:
+
+`<Boolean> activeOnly` – it true, only names of active filters are returned
 
 #### `addFilter( name, callback [, priority = 10 ] )`
 

package/package.json

@@ -7,7 +7,7 @@
     "url" : "https://komed3.de"
   },
   "homepage": "https://github.com/komed3/cmpstr#readme",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "license": "MIT",

package/src/CmpStr.d.ts

@@ -19,7 +19,7 @@ export declare class CmpStr {
 
     getStr () : string;
 
-    listAlgo ( loadedOnly?: boolean ) : string[];
+    listAlgo ( loadedOnly?: boolean = false ) : string[];
 
     isAlgo ( algo: string ) : boolean;
 
@@ -33,11 +33,11 @@ export declare class CmpStr {
 
     rmvAlgo( algo: string ) : boolean;
 
-    listFilter () : string[];
+    listFilter ( activeOnly?: boolean = false ) : string[];
 
     addFilter ( name: string, callback: (
         str: string
-    ) => string, priority?: number ) : boolean;
+    ) => string, priority?: number = 10 ) : boolean;
 
     rmvFilter ( name: string ) : boolean;
 

package/src/CmpStr.js

@@ -233,7 +233,7 @@ module.exports = class CmpStr {
      */
 
     /**
-     * list all registered similarity algorithms
+     * list all registered or loaded similarity algorithms
      * 
      * @param {Boolean} [loadedOnly=false] it true, only loaded algorithm names are returned
      * @returns {String[]} array of algorithm names
@@ -437,13 +437,18 @@ module.exports = class CmpStr {
      */
 
     /**
-     * list all added filters
+     * list all added or artice filter names
      * 
+     * @param {Boolean} [activeOnly=false] if true, only names of active filters are returned
      * @returns {String[]} array of filter names
      */
-    listFilter () {
+    listFilter ( activeOnly = false ) {
 
-        return [ ...this.#filter.keys() ];
+        return activeOnly
+            ? Array.from( this.#filter.entries() )
+                .filter( ( [ _, filter ] ) => filter.active )
+                .map( ( [ name ] ) => name )
+            : [ ...this.#filter.keys() ];
 
     };
 

package/src/CmpStrAsync.d.ts

@@ -2,7 +2,7 @@ import { CmpStr, Config, BatchResult } from './CmpStr';
 
 export declare class CmpStrAsync extends CmpStr {
 
-    normalizeAsync ( input: string|string[], flags?: string ) : string|string[];
+    normalizeAsync ( input: string|string[], flags?: string ) : Promise<string|string[]>;
 
     compareAsync ( algo: string, a: string, b: string, config?: Config ) : Promise<number | any>;
 
@@ -16,4 +16,4 @@ export declare class CmpStrAsync extends CmpStr {
 
     similarityMatrixAsync ( algo: string, arr: string[], config?: Config ) : Promise<number[][]>;
 
-}
+}

package/src/CmpStrAsync.js

@@ -41,7 +41,6 @@ module.exports = class CmpStrAsync extends CmpStr {
 
     /**
      * generic async wrapper for methods
-     * @async
      * 
      * @private
      * @param {Function} method method to call
@@ -96,7 +95,6 @@ module.exports = class CmpStrAsync extends CmpStr {
 
     /**
      * compares two string a and b using the passed algorithm
-     * @async
      * 
      * @param {String} algo name of the algorithm
      * @param {String} a string a
@@ -116,7 +114,6 @@ module.exports = class CmpStrAsync extends CmpStr {
     /**
      * tests the similarity between the base string and a target string
      * using the current algorithm
-     * @async
      * 
      * @param {String} str target string
      * @param {Object} [config={}] config (flags, args)
@@ -133,7 +130,6 @@ module.exports = class CmpStrAsync extends CmpStr {
 
     /**
      * tests the similarity of multiple strings against the base string
-     * @async
      * 
      * @param {String[]} arr array of strings
      * @param {Object} [config={}] config (flags, args)
@@ -151,13 +147,12 @@ module.exports = class CmpStrAsync extends CmpStr {
     /**
      * finds strings in an array that exceed a similarity threshold
      * returns the array sorted by highest similarity
-     * @async
      * 
      * @param {String[]} arr array of strings
      * @param {Object} [config={}] config (flags, threshold, args)
      * @returns {Promise} Promise resolving an array of objects, sorted by highest similarity
      */
-    async matchAsync ( arr, config = {} ) {
+    matchAsync ( arr, config = {} ) {
 
         return this.#asyncWrapper(
             this.match,
@@ -168,13 +163,12 @@ module.exports = class CmpStrAsync extends CmpStr {
 
     /**
      * finds the closest matching string from an array
-     * @async
      * 
      * @param {String[]} arr array of strings
      * @param {Object} [config={}] config (flags, args)
      * @returns {Promise} Promise resolving the closest matching string
      */
-    async closestAsync ( arr, config = {} ) {
+    closestAsync ( arr, config = {} ) {
 
         return this.#asyncWrapper(
             this.closest,
@@ -185,7 +179,6 @@ module.exports = class CmpStrAsync extends CmpStr {
 
     /**
      * generate a similarity matrix for an array of strings
-     * @async
      * 
      * @param {String} algo name of the algorithm
      * @param {String[]} arr array of strings to cross-compare

package/src/index.js

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