cmpstr 3.1.0 → 3.2.0

package/dist/types/CmpStr.d.ts

@@ -20,12 +20,12 @@
  * @author Paul Köhler (komed3)
  * @license MIT
  */
-import type { CmpStrOptions, CmpStrProcessors, CmpStrResult, NormalizeFlags, DiffOptions, PhoneticOptions, MetricRaw, MetricInput, MetricMode, MetricResult, MetricResultSingle, MetricResultBatch, StructuredDataBatchResult, StructuredDataOptions } from './utils/Types';
-import { TextAnalyzer } from './utils/TextAnalyzer';
+import type { BatchResultLike, CmpStrOptions, CmpStrProcessors, CmpStrResult, DiffOptions, MetricInput, MetricMode, MetricRaw, MetricResult, NormalizeFlags, PhoneticOptions, ResultLike, StructuredDataOptions, StructuredResultLike } from './utils/Types';
 import { DiffChecker } from './utils/DiffChecker';
-import { Normalizer } from './utils/Normalizer';
 import { Filter } from './utils/Filter';
+import { Normalizer } from './utils/Normalizer';
 import { StructuredData } from './utils/StructuredData';
+import { TextAnalyzer } from './utils/TextAnalyzer';
 import { Metric } from './metric';
 import { Phonetic } from './phonetic';
 /**
@@ -36,9 +36,9 @@ import { Phonetic } from './phonetic';
  */
 export declare class CmpStr<R = MetricRaw> {
     /**
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      * Static methods and properties for global access to CmpStr features
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      *
      * These static methods provide a convenient way to access the core features of
      * the CmpStr package without needing to instantiate a CmpStr object.
@@ -49,6 +49,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @see Filter
      */
     static readonly filter: {
+        has: typeof Filter.has;
         add: typeof Filter.add;
         remove: typeof Filter.remove;
         pause: typeof Filter.pause;
@@ -95,8 +96,8 @@ export declare class CmpStr<R = MetricRaw> {
      */
     static readonly clearCache: {
         normalizer: typeof Normalizer.clear;
-        metric: typeof Metric.clear;
-        phonetic: typeof Phonetic.clear;
+        metric: () => void;
+        phonetic: () => void;
     };
     /**
      * Returns a TextAnalyzer instance for the given input string.
@@ -104,7 +105,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {string} [input] - The input string
      * @returns {TextAnalyzer} - The text analyzer
      */
-    static analyze(input: string): TextAnalyzer;
+    static analyze: (input: string) => TextAnalyzer;
     /**
      * Returns a DiffChecker instance for computing the unified diff between two texts.
      *
@@ -113,11 +114,11 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {DiffOptions} [opt] - Optional diff configuration
      * @returns {DiffChecker} - The diff checker instance
      */
-    static diff(a: string, b: string, opt?: DiffOptions): DiffChecker;
+    static diff: (a: string, b: string, opt?: DiffOptions) => DiffChecker;
     /**
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      * Instanciate the CmpStr class
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      *
      * Methods to create a new CmpStr instance with the given options.
      * Using the static `create` method is recommended to ensure proper instantiation.
@@ -125,8 +126,8 @@ export declare class CmpStr<R = MetricRaw> {
     /**
      * Creates a new CmpStr instance with the given options.
      *
-     * @param {string|CmpStrOptions} [opt] - Optional serialized or options object
-     * @returns {CmpStr<R>} - A new CmpStr instance
+     * @param {string | CmpStrOptions} [opt] - Optional serialized or options object
+     * @returns {CmpStr< R >} - A new CmpStr instance
      */
     static create<R = MetricRaw>(opt?: string | CmpStrOptions): CmpStr<R>;
     protected options: CmpStrOptions;
@@ -134,13 +135,13 @@ export declare class CmpStr<R = MetricRaw> {
      * Creates a new CmpStr instance with the given options.
      * The constructor is protected to enforce the use of the static `create` method.
      *
-     * @param {string|CmpStrOptions} [opt] - Optional serialized or options object
+     * @param {string | CmpStrOptions} [opt] - Optional serialized or options object
      */
     protected constructor(opt?: string | CmpStrOptions);
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Protected utility methods for internal use
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide utility functions for converting inputs, merging options,
      * normalizing inputs, filtering, and preparing inputs for comparison.
@@ -194,8 +195,8 @@ export declare class CmpStr<R = MetricRaw> {
     /**
      * Post-process the results of the metric computation.
      *
-     * @param {MetricResult<R>} result - The metric result
-     * @returns {MetricResult<R>} - The post-processed results
+     * @param {MetricResult< R >} result - The metric result
+     * @returns {MetricResult< R >} - The post-processed results
      */
     protected postProcess(result: MetricResult<R>, opt?: CmpStrOptions): MetricResult<R>;
     /**
@@ -215,7 +216,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @template T - The type of objects in the data array
      * @param {T[]} data - The array of structured objects
      * @param {keyof T} key - The property key to compare
-     * @returns {StructuredData<T, R>} - The lookup instance
+     * @returns {StructuredData< T, R >} - The lookup instance
      */
     protected structured<T = any>(data: T[], key: keyof T): StructuredData<T, R>;
     /**
@@ -236,15 +237,15 @@ export declare class CmpStr<R = MetricRaw> {
      * Resolves the result format (raw or formatted).
      *
      * @template T - The type of the metric result
-     * @param {MetricResult<R>} result - The metric result
+     * @param {MetricResult< R >} result - The metric result
      * @param {boolean} [raw] - Whether to return raw results
      * @returns {T} - The resolved result
      */
     protected output<T extends MetricResult<R> | CmpStrResult | CmpStrResult[]>(result: MetricResult<R>, raw?: boolean): T;
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Managing methods for CmpStr
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provides an interface to set and get properties of the CmpStr
      * instance, such as options, metric, phonetic algorithm, and more.
@@ -252,9 +253,9 @@ export declare class CmpStr<R = MetricRaw> {
     /**
      * Creates a shallow clone of the current instance.
      *
-     * @returns {CmpStr<R>} - The cloned instance
+     * @returns {CmpStr< R >} - The cloned instance
      */
-    clone(): CmpStr<R>;
+    clone: () => CmpStr<R>;
     /**
      * Resets the instance, clearing all data and options.
      *
@@ -303,63 +304,63 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {boolean} enable - Whether to enable or disable raw output
      * @returns {this}
      */
-    setRaw(enable: boolean): this;
+    setRaw: (enable: boolean) => this;
     /**
      * Sets the similatity metric to use (e.g., 'levenshtein', 'dice').
      *
      * @param {string} name - The metric name
      * @returns {this}
      */
-    setMetric(name: string): this;
+    setMetric: (name: string) => this;
     /**
      * Sets the normalization flags (e.g., 'itw', 'nfc').
      *
      * @param {NormalizeFlags} flags - The normalization flags
      * @returns {this}
      */
-    setFlags(flags: NormalizeFlags): this;
+    setFlags: (flags: NormalizeFlags) => this;
     /**
      * Removes the normalization flags entirely.
      *
      * @return {this}
      */
-    rmvFlags(): this;
+    rmvFlags: () => this;
     /**
      * Sets the pre-processors to use for preparing the input.
      *
      * @param {CmpStrProcessors} opt - The processors to set
      * @returns {this}
      */
-    setProcessors(opt: CmpStrProcessors): this;
+    setProcessors: (opt: CmpStrProcessors) => this;
     /**
      * Removes the processors entirely.
      *
      * @returns {this}
      */
-    rmvProcessors(): this;
+    rmvProcessors: () => this;
     /**
      * Returns the current options object.
      *
      * @returns {CmpStrOptions} - The options
      */
-    getOptions(): CmpStrOptions;
+    getOptions: () => CmpStrOptions;
     /**
      * Returns the options as a JSON string.
      *
      * @returns {string} - The serialized options
      */
-    getSerializedOptions(): string;
+    getSerializedOptions: () => string;
     /**
      * Returns a specific option value by path.
      *
      * @param {string} path - The path to the option
      * @returns {any} - The option value
      */
-    getOption(path: string): any;
+    getOption: (path: string) => any;
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Public core methods for string comparison
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide the core functionality of the CmpStr class, allowing for
      * string comparison, phonetic indexing, filtering, and text search.
@@ -373,7 +374,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The metric result
      */
-    test<T extends CmpStrResult | MetricResultSingle<R> = any>(a: string, b: string, opt?: CmpStrOptions): T;
+    test<T extends ResultLike<R> = any>(a: string, b: string, opt?: CmpStrOptions): T;
     /**
      * Performs a single metric comparison and returns only the numeric score.
      *
@@ -393,18 +394,18 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The batch metric results
      */
-    batchTest<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): T;
+    batchTest<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): T;
     /**
      * Performs a batch metric comparison and returns results sorted by score.
      *
      * @template T - The type of the metric result
      * @param {MetricInput} a - The source string or array of strings
      * @param {MetricInput} b - The target string or array of strings
-     * @param {'desc'|'asc'} [dir='desc'] - Sort direction (desc, asc)
+     * @param {'desc' | 'asc'} [dir='desc'] - Sort direction (desc, asc)
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The sorted batch results
      */
-    batchSorted<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, dir?: 'desc' | 'asc', opt?: CmpStrOptions): T;
+    batchSorted<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, dir?: 'desc' | 'asc', opt?: CmpStrOptions): T;
     /**
      * Performs a pairwise metric comparison between source and target strings
      * or array of strings.
@@ -418,7 +419,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The pairwise metric results
      */
-    pairs<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): T;
+    pairs<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): T;
     /**
      * Performs a batch comparison and returns only results above the threshold.
      *
@@ -429,7 +430,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The filtered batch results
      */
-    match<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, threshold: number, opt?: CmpStrOptions): T;
+    match<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, threshold: number, opt?: CmpStrOptions): T;
     /**
      * Returns the n closest matches from a batch comparison.
      *
@@ -440,7 +441,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The closest matches
      */
-    closest<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): T;
+    closest<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): T;
     /**
      * Returns the n furthest matches from a batch comparison.
      *
@@ -451,7 +452,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {T} - The furthest matches
      */
-    furthest<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): T;
+    furthest<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): T;
     /**
      * Performs a normalized and filtered substring search.
      *
@@ -481,9 +482,9 @@ export declare class CmpStr<R = MetricRaw> {
      */
     phoneticIndex(input: string, algo?: string, opt?: PhoneticOptions): string;
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Public methods for structured data comparison
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide interfaces for comparing arrays of structured objects
      * by extracting and comparing specific properties.
@@ -497,9 +498,9 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {T[]} data - The array of structured objects
      * @param {keyof T} key - The property key to extract for comparison
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {StructuredDataBatchResult<T, R>|T[]} - Batch results with original objects
+     * @returns {StructuredResultLike< T, R >} - Batch results with original objects
      */
-    structuredLookup<T = any>(query: string, data: T[], key: keyof T, opt?: StructuredDataOptions): StructuredDataBatchResult<T, R> | T[];
+    structuredLookup<T = any>(query: string, data: T[], key: keyof T, opt?: StructuredDataOptions): StructuredResultLike<T, R>;
     /**
      * Performs a batch comparison and returns only results above the threshold
      * for structured data.
@@ -510,9 +511,9 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} threshold - The similarity threshold (0..1)
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {StructuredDataBatchResult<T, R>|T[]} - Filtered batch results with objects
+     * @returns {StructuredResultLike< T, R >} - Filtered batch results with objects
      */
-    structuredMatch<T = any>(query: string, data: T[], key: keyof T, threshold: number, opt?: StructuredDataOptions): StructuredDataBatchResult<T, R> | T[];
+    structuredMatch<T = any>(query: string, data: T[], key: keyof T, threshold: number, opt?: StructuredDataOptions): StructuredResultLike<T, R>;
     /**
      * Returns the n closest matches from a batch comparison of structured data.
      *
@@ -522,9 +523,9 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} [n=1] - Number of closest matches
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {StructuredDataBatchResult<T, R>|T[]} - Closest matches with objects
+     * @returns {StructuredResultLike< T, R >} - Closest matches with objects
      */
-    structuredClosest<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): StructuredDataBatchResult<T, R> | T[];
+    structuredClosest<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): StructuredResultLike<T, R>;
     /**
      * Returns the n furthest matches from a batch comparison of structured data.
      *
@@ -534,9 +535,9 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} [n=1] - Number of furthest matches
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {StructuredDataBatchResult<T, R>|T[]} - Furthest matches with objects
+     * @returns {StructuredResultLike< T, R >} - Furthest matches with objects
      */
-    structuredFurthest<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): StructuredDataBatchResult<T, R> | T[];
+    structuredFurthest<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): StructuredResultLike<T, R>;
     /**
      * Performs a pairwise comparison between two arrays of structured objects
      * by extracting specific properties and returning results with original objects attached.
@@ -548,7 +549,7 @@ export declare class CmpStr<R = MetricRaw> {
      * @param {O[]} other - The other array of structured objects
      * @param {keyof O} otherKey - The property key to extract from other array
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {StructuredDataBatchResult<T, R>|T[]} - Pairwise results with original objects
+     * @returns {StructuredResultLike< T, R >} - Pairwise results with original objects
      */
-    structuredPairs<T = any, O = any>(data: T[], key: keyof T, other: O[], otherKey: keyof O, opt?: StructuredDataOptions): StructuredDataBatchResult<T, R> | T[];
+    structuredPairs<T = any, O = any>(data: T[], key: keyof T, other: O[], otherKey: keyof O, opt?: StructuredDataOptions): StructuredResultLike<T, R>;
 }

package/dist/types/CmpStrAsync.d.ts

@@ -19,7 +19,7 @@
  * @author Paul Köhler (komed3)
  * @license MIT
  */
-import type { CmpStrOptions, CmpStrProcessors, CmpStrResult, NormalizeFlags, PhoneticOptions, MetricRaw, MetricInput, MetricMode, MetricResult, MetricResultSingle, MetricResultBatch, StructuredDataBatchResult, StructuredDataOptions } from './utils/Types';
+import type { BatchResultLike, CmpStrOptions, CmpStrProcessors, CmpStrResult, MetricInput, MetricMode, MetricRaw, MetricResult, NormalizeFlags, PhoneticOptions, ResultLike, StructuredDataOptions, StructuredResultLike } from './utils/Types';
 import { CmpStr } from './CmpStr';
 /**
  * The CmpStrAsync class provides a fully asynchronous API for string comparison,
@@ -29,9 +29,9 @@ import { CmpStr } from './CmpStr';
  */
 export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
     /**
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      * Instanciate the CmpStrAsync class
-     * --------------------------------------------------------------------------------
+     * ================================================================================
      *
      * Methods to create a new CmpStrAsync instance with the given options.
      * Using the static `create` method is recommended to ensure proper instantiation.
@@ -39,20 +39,20 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
     /**
      * Creates a new CmpStrAsync instance with the given options.
      *
-     * @param {string|CmpStrOptions} [opt] - Optional serialized or options object
-     * @returns {CmpStrAsync<R>} - A new CmpStrAsync instance
+     * @param {string | CmpStrOptions} [opt] - Optional serialized or options object
+     * @returns {CmpStrAsync< R >} - A new CmpStrAsync instance
      */
     static create<R = MetricRaw>(opt?: string | CmpStrOptions): CmpStrAsync<R>;
     /**
      * Creates a new CmpStrAsync instance calliing the super constructor.
      *
-     * @param {string|CmpStrOptions} [opt] - Optional serialized or options object
+     * @param {string | CmpStrOptions} [opt] - Optional serialized or options object
      */
     protected constructor(opt?: string | CmpStrOptions);
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Protected asynchronously utility methods for internal use
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide asynchronous normalization, filtering, and metric
      * computation capabilities, allowing for non-blocking operations.
@@ -62,7 +62,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      *
      * @param {MetricInput} input - The input string or array
      * @param {NormalizeFlags} [flags] - Normalization flags
-     * @returns {Promise<MetricInput>} - The normalized input
+     * @returns {Promise< MetricInput >} - The normalized input
      */
     protected normalizeAsync(input: MetricInput, flags?: NormalizeFlags): Promise<MetricInput>;
     /**
@@ -70,7 +70,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      *
      * @param {MetricInput} input - The input string or array
      * @param {string} [hook='input'] - The filter hook
-     * @returns {Promise<MetricInput>} - The filtered string(s)
+     * @returns {Promise< MetricInput >} - The filtered string(s)
      */
     protected filterAsync(input: MetricInput, hook: string): Promise<MetricInput>;
     /**
@@ -78,7 +78,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      *
      * @param {MetricInput} [input] - The input string or array
      * @param {CmpStrOptions} [opt] - Optional options to use
-     * @returns {Promise<MetricInput>} - The prepared input
+     * @returns {Promise< MetricInput >} - The prepared input
      */
     protected prepareAsync(input: MetricInput, opt?: CmpStrOptions): Promise<MetricInput>;
     /**
@@ -87,7 +87,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      *
      * @param {MetricInput} input - The input string or array
      * @param {{ algo: string, opt?: PhoneticOptions }} options - The phonetic algorithm and options
-     * @returns {Promise<MetricInput>} - The phonetic index for the given input
+     * @returns {Promise< MetricInput >} - The phonetic index for the given input
      */
     protected indexAsync(input: MetricInput, { algo, opt }: {
         algo: string;
@@ -104,13 +104,13 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {MetricMode} [mode='single'] - The metric mode to use
      * @param {boolean} [raw=false] - Whether to return raw results
      * @param {boolean} [skip=false] - Whether to skip normalization and filtering
-     * @returns {Promise<T>} - The computed metric result
+     * @returns {Promise< T >} - The computed metric result
      */
     protected computeAsync<T extends MetricResult<R> | CmpStrResult | CmpStrResult[]>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions, mode?: MetricMode, raw?: boolean, skip?: boolean): Promise<T>;
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Public asynchronously core methods for string comparison
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide the asynchronous core functionality for string comparison,
      * phonetic indexing and text search, allowing for non-blocking operations.
@@ -122,16 +122,16 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {string} a - The source string
      * @param {string} b - The target string
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The metric result
+     * @returns {Promise< T >} - The metric result
      */
-    testAsync<T extends CmpStrResult | MetricResultSingle<R> = any>(a: string, b: string, opt?: CmpStrOptions): Promise<T>;
+    testAsync<T extends ResultLike<R> = any>(a: string, b: string, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously performs a single metric comparison returning the numeric score.
      *
      * @param {string} a - The source string
      * @param {string} b - The target string
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<number>} - The similarity score (0..1)
+     * @returns {Promise< number >} - The similarity score (0..1)
      */
     compareAsync(a: string, b: string, opt?: CmpStrOptions): Promise<number>;
     /**
@@ -142,34 +142,34 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {MetricInput} a - The source string or array of strings
      * @param {MetricInput} b - The target string or array of strings
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The batch metric results
+     * @returns {Promise< T >} - The batch metric results
      */
-    batchTestAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): Promise<T>;
+    batchTestAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously performs a batch metric comparison and returns results sorted by score.
      *
      * @template T - The type of the metric result
      * @param {MetricInput} a - The source string or array of strings
      * @param {MetricInput} b - The target string or array of strings
-     * @param {'desc'|'asc'} [dir='desc'] - Sort direction (desc, asc)
+     * @param {'desc' | 'asc'} [dir='desc'] - Sort direction (desc, asc)
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The sorted batch results
+     * @returns {Promise< T >} - The sorted batch results
      */
-    batchSortedAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, dir?: 'desc' | 'asc', opt?: CmpStrOptions): Promise<T>;
+    batchSortedAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, dir?: 'desc' | 'asc', opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously performs a pairwise metric comparison between source and target
      * strings or array of strings.
      *
-     * @template T - The type of the metric result
      * Input arrays needs of the same length to perform pairwise comparison,
      * otherwise the method will throw an error.
      *
+     * @template T - The type of the metric result
      * @param {MetricInput} a - The source string or array of strings
      * @param {MetricInput} b - The target string or array of strings
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The pairwise metric results
+     * @returns {Promise< T >} - The pairwise metric results
      */
-    pairsAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): Promise<T>;
+    pairsAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously performs a batch comparison and returns only results above the threshold.
      *
@@ -178,9 +178,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {MetricInput} b - The target string or array of strings
      * @param {number} threshold - The similarity threshold (0..1)
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The filtered batch results
+     * @returns {Promise< T >} - The filtered batch results
      */
-    matchAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, threshold: number, opt?: CmpStrOptions): Promise<T>;
+    matchAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, threshold: number, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously returns the n closest matches from a batch comparison.
      *
@@ -189,9 +189,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {MetricInput} b - The target string or array of strings
      * @param {number} [n=1] - Number of closest matches
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<T>} - The closest matches
+     * @returns {Promise< T >} - The closest matches
      */
-    closestAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): Promise<T>;
+    closestAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously returns the n furthest matches from a batch comparison.
      *
@@ -202,7 +202,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {CmpStrOptions} [opt] - Optional options
      * @returns {Promise<T>} - The furthest matches
      */
-    furthestAsync<T extends CmpStrResult[] | MetricResultBatch<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): Promise<T>;
+    furthestAsync<T extends BatchResultLike<R> = any>(a: MetricInput, b: MetricInput, n?: number, opt?: CmpStrOptions): Promise<T>;
     /**
      * Asynchronously performs a normalized and filtered substring search.
      *
@@ -210,7 +210,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {string[]} haystack - The array to search in
      * @param {NormalizeFlags} [flags] - Normalization flags
      * @param {CmpStrProcessors} [processors] - Pre-processors to apply
-     * @returns {Promise<string[]>} - Array of matching entries
+     * @returns {Promise< string[] >} - Array of matching entries
      */
     searchAsync(needle: string, haystack: string[], flags?: NormalizeFlags, processors?: CmpStrProcessors): Promise<string[]>;
     /**
@@ -218,7 +218,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      *
      * @param {string[]} input - The input array
      * @param {CmpStrOptions} [opt] - Optional options
-     * @returns {Promise<number[][]>} - The similarity matrix
+     * @returns {Promise< number[][] >} - The similarity matrix
      */
     matrixAsync(input: string[], opt?: CmpStrOptions): Promise<number[][]>;
     /**
@@ -232,9 +232,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      */
     phoneticIndexAsync(input: string, algo?: string, opt?: PhoneticOptions): Promise<string>;
     /**
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      * Public asynchronous methods for structured data comparison
-     * ---------------------------------------------------------------------------------
+     * ================================================================================-
      *
      * These methods provide asynchronous interfaces for comparing arrays of
      * structured objects by extracting and comparing specific properties.
@@ -248,9 +248,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {T[]} data - The array of structured objects
      * @param {keyof T} key - The property key to extract for comparison
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {Promise<StructuredDataBatchResult<T, R>|T[]>} - Async batch results with original objects
+     * @returns {Promise< StructuredResultLike< T, R > >} - Async batch results with original objects
      */
-    structuredLookupAsync<T = any>(query: string, data: T[], key: keyof T, opt?: StructuredDataOptions): Promise<StructuredDataBatchResult<T, R> | T[]>;
+    structuredLookupAsync<T = any>(query: string, data: T[], key: keyof T, opt?: StructuredDataOptions): Promise<StructuredResultLike<T, R>>;
     /**
      * Asynchronously performs a batch comparison and returns only results above
      * the threshold for structured data.
@@ -261,9 +261,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} threshold - The similarity threshold (0..1)
      * @param {StructuredDataLookupOptions} [opt] - Optional lookup options
-     * @returns {Promise<StructuredDataBatchResult<T, R>|T[]>} - Async filtered batch results
+     * @returns {Promise< StructuredResultLike< T, R > >} - Async filtered batch results
      */
-    structuredMatchAsync<T = any>(query: string, data: T[], key: keyof T, threshold: number, opt?: StructuredDataOptions): Promise<StructuredDataBatchResult<T, R> | T[]>;
+    structuredMatchAsync<T = any>(query: string, data: T[], key: keyof T, threshold: number, opt?: StructuredDataOptions): Promise<StructuredResultLike<T, R>>;
     /**
      * Asynchronously returns the n closest matches from a batch comparison
      * of structured data.
@@ -274,9 +274,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} [n=1] - Number of closest matches
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {Promise<StructuredDataBatchResult<T, R>|T[]>} - Async closest matches
+     * @returns {Promise< StructuredResultLike< T, R > >} - Async closest matches
      */
-    structuredClosestAsync<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): Promise<StructuredDataBatchResult<T, R> | T[]>;
+    structuredClosestAsync<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): Promise<StructuredResultLike<T, R>>;
     /**
      * Asynchronously returns the n furthest matches from a batch comparison
      * of structured data.
@@ -287,9 +287,9 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {keyof T} key - The property key to extract for comparison
      * @param {number} [n=1] - Number of furthest matches
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {Promise<StructuredDataBatchResult<T, R>|T[]>} - Async furthest matches
+     * @returns {Promise< StructuredResultLike< T, R > >} - Async furthest matches
      */
-    structuredFurthestAsync<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): Promise<StructuredDataBatchResult<T, R> | T[]>;
+    structuredFurthestAsync<T = any>(query: string, data: T[], key: keyof T, n?: number, opt?: StructuredDataOptions): Promise<StructuredResultLike<T, R>>;
     /**
      * Asynchronously performs a pairwise comparison between two arrays of structured objects
      * by extracting specific properties and returning results with original objects attached.
@@ -301,7 +301,7 @@ export declare class CmpStrAsync<R = MetricRaw> extends CmpStr<R> {
      * @param {T[]} other - The other array of structured objects
      * @param {keyof T} otherKey - The property key to extract from other array
      * @param {StructuredDataOptions} [opt] - Optional lookup options
-     * @returns {Promise<StructuredDataBatchResult<T, R>|T[]>} - Async pairwise results with original objects
+     * @returns {Promise< StructuredResultLike< T, R > >} - Async pairwise results with original objects
      */
-    structuredPairsAsync<T = any, O = any>(data: T[], key: keyof T, other: O[], otherKey: keyof O, opt?: StructuredDataOptions): Promise<StructuredDataBatchResult<T, R> | T[]>;
+    structuredPairsAsync<T = any, O = any>(data: T[], key: keyof T, other: O[], otherKey: keyof O, opt?: StructuredDataOptions): Promise<StructuredResultLike<T, R>>;
 }