data-structure-typed 1.49.8 → 1.49.9

package/dist/cjs/types/data-structures/hash/hash-map.d.ts

@@ -8,8 +8,9 @@ export type LinkedHashMapOptions<K> = {
     hashFn?: (key: K) => string;
     objHashFn?: (key: K) => object;
 };
-export type HashMapOptions<K> = {
+export type HashMapOptions<K, V, T> = {
     hashFn?: (key: K) => string;
+    toEntryFn?: (rawElement: T) => [K, V];
 };
 export type HashMapStoreItem<K, V> = {
     key: K;

package/dist/mjs/data-structures/hash/hash-map.d.ts

@@ -13,20 +13,22 @@ import { IterableEntryBase } from '../base';
  * 3. Unique Keys: Keys are unique. If you try to insert another entry with the same key, the old entry will be replaced by the new one.
  * 4. Unordered Collection: HashMap does not guarantee the order of entries, and the order may change over time.
  */
-export declare class HashMap<K = any, V = any> extends IterableEntryBase<K, V> {
+export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K, V> {
     protected _store: {
         [key: string]: HashMapStoreItem<K, V>;
     };
     protected _objMap: Map<object, V>;
+    protected _toEntryFn: (rawElement: R) => [K, V];
+    get toEntryFn(): (rawElement: R) => [K, V];
+    isEntry(rawElement: any): rawElement is [K, V];
     /**
-     * The constructor function initializes a new instance of a class with optional entries and options.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs `[K, V]`. It
-     * is optional and defaults to an empty array `[]`. This parameter is used to initialize the map with
-     * key-value pairs.
-     * @param [options] - The `options` parameter is an optional object that can contain additional
-     * configuration options for the constructor. In this case, it has one property:
+     * The constructor function initializes a HashMap object with an optional initial collection and
+     * options.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`. It is an optional parameter and its default value is an empty array `[]`.
+     * @param [options] - The `options` parameter is an optional object that can contain two properties:
      */
-    constructor(entries?: Iterable<[K, V]>, options?: HashMapOptions<K>);
+    constructor(rawCollection?: Iterable<R>, options?: HashMapOptions<K, V, R>);
     protected _size: number;
     get size(): number;
     isEmpty(): boolean;
@@ -42,11 +44,13 @@ export declare class HashMap<K = any, V = any> extends IterableEntryBase<K, V> {
      */
     set(key: K, value: V): boolean;
     /**
-     * The function "setMany" sets multiple key-value pairs in a map.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs. Each
-     * key-value pair is represented as an array with two entries: the key and the value.
+     * The function `setMany` takes an iterable collection of objects, maps each object to a key-value
+     * pair using a mapping function, and sets each key-value pair in the current object.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`.
+     * @returns The `setMany` function is returning an array of booleans.
      */
-    setMany(entries: Iterable<[K, V]>): boolean[];
+    setMany(rawCollection: Iterable<R>): boolean[];
     /**
      * The `get` function retrieves a value from a map based on a given key, either from an object map or
      * a string map.

package/dist/mjs/data-structures/hash/hash-map.js

@@ -9,24 +9,41 @@ import { isWeakKey, rangeCheck } from '../../utils';
 export class HashMap extends IterableEntryBase {
     _store = {};
     _objMap = new Map();
+    _toEntryFn = (rawElement) => {
+        if (this.isEntry(rawElement)) {
+            // TODO, For performance optimization, it may be necessary to only inspect the first element traversed.
+            return rawElement;
+        }
+        else {
+            throw new Error("If the provided rawCollection does not adhere to the [key, value] type format, the toEntryFn in the constructor's options parameter needs to specified.");
+        }
+    };
+    get toEntryFn() {
+        return this._toEntryFn;
+    }
+    isEntry(rawElement) {
+        return Array.isArray(rawElement) && rawElement.length === 2;
+    }
     /**
-     * The constructor function initializes a new instance of a class with optional entries and options.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs `[K, V]`. It
-     * is optional and defaults to an empty array `[]`. This parameter is used to initialize the map with
-     * key-value pairs.
-     * @param [options] - The `options` parameter is an optional object that can contain additional
-     * configuration options for the constructor. In this case, it has one property:
+     * The constructor function initializes a HashMap object with an optional initial collection and
+     * options.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`. It is an optional parameter and its default value is an empty array `[]`.
+     * @param [options] - The `options` parameter is an optional object that can contain two properties:
      */
-    constructor(entries = [], options) {
+    constructor(rawCollection = [], options) {
         super();
         if (options) {
-            const { hashFn } = options;
+            const { hashFn, toEntryFn } = options;
             if (hashFn) {
                 this._hashFn = hashFn;
             }
+            if (toEntryFn) {
+                this._toEntryFn = toEntryFn;
+            }
         }
-        if (entries) {
-            this.setMany(entries);
+        if (rawCollection) {
+            this.setMany(rawCollection);
         }
     }
     _size = 0;
@@ -67,14 +84,18 @@ export class HashMap extends IterableEntryBase {
         return true;
     }
     /**
-     * The function "setMany" sets multiple key-value pairs in a map.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs. Each
-     * key-value pair is represented as an array with two entries: the key and the value.
+     * The function `setMany` takes an iterable collection of objects, maps each object to a key-value
+     * pair using a mapping function, and sets each key-value pair in the current object.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`.
+     * @returns The `setMany` function is returning an array of booleans.
      */
-    setMany(entries) {
+    setMany(rawCollection) {
         const results = [];
-        for (const [key, value] of entries)
+        for (const rawEle of rawCollection) {
+            const [key, value] = this.toEntryFn(rawEle);
             results.push(this.set(key, value));
+        }
         return results;
     }
     /**

package/dist/mjs/types/data-structures/hash/hash-map.d.ts

@@ -8,8 +8,9 @@ export type LinkedHashMapOptions<K> = {
     hashFn?: (key: K) => string;
     objHashFn?: (key: K) => object;
 };
-export type HashMapOptions<K> = {
+export type HashMapOptions<K, V, T> = {
     hashFn?: (key: K) => string;
+    toEntryFn?: (rawElement: T) => [K, V];
 };
 export type HashMapStoreItem<K, V> = {
     key: K;

package/dist/umd/data-structure-typed.js

@@ -585,29 +585,46 @@ var dataStructureTyped = (() => {
   // src/data-structures/hash/hash-map.ts
   var HashMap = class _HashMap extends IterableEntryBase {
     /**
-     * The constructor function initializes a new instance of a class with optional entries and options.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs `[K, V]`. It
-     * is optional and defaults to an empty array `[]`. This parameter is used to initialize the map with
-     * key-value pairs.
-     * @param [options] - The `options` parameter is an optional object that can contain additional
-     * configuration options for the constructor. In this case, it has one property:
+     * The constructor function initializes a HashMap object with an optional initial collection and
+     * options.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`. It is an optional parameter and its default value is an empty array `[]`.
+     * @param [options] - The `options` parameter is an optional object that can contain two properties:
      */
-    constructor(entries = [], options) {
+    constructor(rawCollection = [], options) {
       super();
       __publicField(this, "_store", {});
       __publicField(this, "_objMap", /* @__PURE__ */ new Map());
+      __publicField(this, "_toEntryFn", (rawElement) => {
+        if (this.isEntry(rawElement)) {
+          return rawElement;
+        } else {
+          throw new Error(
+            "If the provided rawCollection does not adhere to the [key, value] type format, the toEntryFn in the constructor's options parameter needs to specified."
+          );
+        }
+      });
       __publicField(this, "_size", 0);
       __publicField(this, "_hashFn", (key) => String(key));
       if (options) {
-        const { hashFn } = options;
+        const { hashFn, toEntryFn } = options;
         if (hashFn) {
           this._hashFn = hashFn;
         }
+        if (toEntryFn) {
+          this._toEntryFn = toEntryFn;
+        }
       }
-      if (entries) {
-        this.setMany(entries);
+      if (rawCollection) {
+        this.setMany(rawCollection);
       }
     }
+    get toEntryFn() {
+      return this._toEntryFn;
+    }
+    isEntry(rawElement) {
+      return Array.isArray(rawElement) && rawElement.length === 2;
+    }
     get size() {
       return this._size;
     }
@@ -644,14 +661,18 @@ var dataStructureTyped = (() => {
       return true;
     }
     /**
-     * The function "setMany" sets multiple key-value pairs in a map.
-     * @param entries - The `entries` parameter is an iterable containing key-value pairs. Each
-     * key-value pair is represented as an array with two entries: the key and the value.
+     * The function `setMany` takes an iterable collection of objects, maps each object to a key-value
+     * pair using a mapping function, and sets each key-value pair in the current object.
+     * @param rawCollection - The `rawCollection` parameter is an iterable collection of elements of type
+     * `T`.
+     * @returns The `setMany` function is returning an array of booleans.
      */
-    setMany(entries) {
+    setMany(rawCollection) {
       const results = [];
-      for (const [key, value] of entries)
+      for (const rawEle of rawCollection) {
+        const [key, value] = this.toEntryFn(rawEle);
         results.push(this.set(key, value));
+      }
       return results;
     }
     /**