@gkucmierz/utils 1.28.1 → 1.28.3

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gkucmierz/utils",
-  "version": "1.28.1",
+  "version": "1.28.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@gkucmierz/utils",
-      "version": "1.28.1",
+      "version": "1.28.3",
       "license": "MIT",
       "devDependencies": {
         "docdash": "^2.0.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gkucmierz/utils",
-  "version": "1.28.1",
+  "version": "1.28.3",
   "description": "Usefull functions for solving programming tasks",
   "main": "main.mjs",
   "scripts": {

package/spec/memoize.spec.mjs

@@ -28,5 +28,19 @@ describe('memoize', () => {
     expect(fn(1, 2)).toBe(2);
     expect(fn(1, 2, 3)).toBe(3);
   });
+
+  it('different empty object arrays', () => {
+    let cnt = 0;
+    const fn = memoize(() => ++cnt);
+    const emptyArr = [];
+    fn(emptyArr);
+    expect(cnt).toBe(1);
+    fn(emptyArr);
+    expect(cnt).toBe(1);
+    fn([]);
+    expect(cnt).toBe(2);
+    fn([]);
+    expect(cnt).toBe(3);
+  });
 });
 

package/src/copy-case.mjs

@@ -1,6 +1,7 @@
 
 /**
  * Copy the case of a string into another.
+ * @method
  * @param {string} target String to change the case.
  * @param {string} source Source of case pattern.
  * @return {string} Converted string.

package/src/gcd.mjs

@@ -17,6 +17,7 @@ const getGCD = ZERO => {
 
 /**
  * Calculate GCD - Greatest Common Divisor
+ * @method
  * @param {Number} Natural number
  * @return {Number} GCD
  */
@@ -24,6 +25,7 @@ export const gcd = getGCD(0);
 
 /**
  * Calculate GCD - Greatest Common Divisor (BigInt version)
+ * @method
  * @param {BigInt} Natural BigInt number
  * @return {BigInt} GCD
  */

package/src/memoize.mjs

@@ -1,4 +1,11 @@
 
+/**
+ * Memoize function, that builds tree structure for arguments
+ * and compares arguments by reference
+ * @method
+ * @param {Function} Function to memoize
+ * @return {Function} Memoized function
+ */
 export const memoize = fn => {
   const maps = [];
 

package/src/mod.mjs

@@ -1,6 +1,4 @@
 
-// python like mod implementation
-
 const getMod = ZERO => {
   return (dividend, divisor) => {
     if ((dividend < ZERO) ^ (divisor < ZERO)) {
@@ -11,5 +9,24 @@ const getMod = ZERO => {
   };
 };
 
+/**
+ * Python like modulo implementation.
+ * It behaves different than JavaScript %
+ * with negative values
+ * @method
+ * @param {Number} Dividend
+ * @param {Number} Divisor
+ * @return {Number} Modulus
+ */
 export const mod = getMod(0);
+
+/**
+ * Python like modulo implementation.
+ * It behaves different than JavaScript %
+ * with negative values
+ * @method
+ * @param {BigInt} Dividend
+ * @param {BigInt} Divisor
+ * @return {BigInt} Modulus
+ */
 export const modBI = getMod(0n);

package/src/pow-mod.mjs

@@ -18,6 +18,22 @@ const getPowMod = (ZERO, ONE, TWO, floor) => {
   };
 };
 
+/**
+ * Power like python implementation with optional modulus
+ * @method
+ * @param {Number} Base
+ * @param {Number} Exponent
+ * @param [Number] Modulus
+ * @return {Number} Power
+ */
 export const powMod = getPowMod(0, 1, 2, n => Math.floor(n));
 
+/**
+ * Power like python implementation with optional modulus
+ * @method
+ * @param {BigInt} Base
+ * @param {BigInt} Exponent
+ * @param [BigInt] Modulus
+ * @return {BigInt} Power
+ */
 export const powModBI = getPowMod(0n, 1n, 2n, n => n);