@etsoo/shared 1.1.96 → 1.1.97

package/README.md

@@ -102,6 +102,7 @@ Array related utilities
 |Name|Description|
 |---:|---|
 |differences|Array 1 items do not exist in Array 2 or reverse match|
+|sum|Sum number items or number item properties|
 |toUnique|Make all items are unique|
 
 ## DataTypes

package/__tests__/ArrayUtils.ts

@@ -20,3 +20,16 @@ test('Tests for differences', () => {
     expect(ArrayUtils.differences(a1, a2)).toEqual(['b', 'e']);
     expect(ArrayUtils.differences(a1, a2, true)).toEqual(['b', 'e', 'd']);
 });
+
+test('Tests for sum numbers', () => {
+    const items = [12, 8, 22];
+    expect(items.sum()).toBe(42);
+});
+
+test('Tests for sum fields', () => {
+    const items = [
+        { id: 1, label: 'a', amount: 3.14 },
+        { id: 2, label: 'b', amount: 4.54 }
+    ];
+    expect(items.sum('amount')).toBe(7.68);
+});

package/lib/cjs/ArrayUtils.d.ts

@@ -1,3 +1,4 @@
+import { DataTypes } from './DataTypes';
 declare global {
     interface Array<T> {
         /**
@@ -6,6 +7,11 @@ declare global {
          * @param round A round for both matches
          */
         different(target: Array<T>, round?: boolean): Array<T>;
+        /**
+         * Sum number items or number item properties
+         * @param field Object field to calculate
+         */
+        sum(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
         /**
          * Make all items are unique
          * @param this Input array

package/lib/cjs/ArrayUtils.js

@@ -19,6 +19,12 @@ Array.prototype.toUnique = function () {
     });
     return newArray;
 };
+Array.prototype.sum = function (field) {
+    if (field == null) {
+        return this.reduce((total, num) => total + num, 0);
+    }
+    return this.reduce((total, item) => total + item[field], 0);
+};
 /**
  * Array Utilities
  */

package/lib/mjs/ArrayUtils.d.ts

@@ -1,3 +1,4 @@
+import { DataTypes } from './DataTypes';
 declare global {
     interface Array<T> {
         /**
@@ -6,6 +7,11 @@ declare global {
          * @param round A round for both matches
          */
         different(target: Array<T>, round?: boolean): Array<T>;
+        /**
+         * Sum number items or number item properties
+         * @param field Object field to calculate
+         */
+        sum(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
         /**
          * Make all items are unique
          * @param this Input array

package/lib/mjs/ArrayUtils.js

@@ -13,6 +13,12 @@ Array.prototype.toUnique = function () {
     });
     return newArray;
 };
+Array.prototype.sum = function (field) {
+    if (field == null) {
+        return this.reduce((total, num) => total + num, 0);
+    }
+    return this.reduce((total, item) => total + item[field], 0);
+};
 /**
  * Array Utilities
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.96",
+    "version": "1.1.97",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/ArrayUtils.ts

@@ -1,4 +1,5 @@
 import isEqual from 'lodash.isequal';
+import { DataTypes } from './DataTypes';
 
 declare global {
     interface Array<T> {
@@ -9,6 +10,18 @@ declare global {
          */
         different(target: Array<T>, round?: boolean): Array<T>;
 
+        /**
+         * Sum number items or number item properties
+         * @param field Object field to calculate
+         */
+        sum(
+            ...field: T extends number
+                ? [undefined?]
+                : T extends object
+                ? [DataTypes.Keys<T, number>]
+                : [never]
+        ): number;
+
         /**
          * Make all items are unique
          * @param this Input array
@@ -37,6 +50,17 @@ Array.prototype.toUnique = function <T>(this: Array<T>) {
     return newArray;
 };
 
+Array.prototype.sum = function <T>(
+    this: Array<T>,
+    field: T extends object ? DataTypes.Keys<T, number> : undefined
+) {
+    if (field == null) {
+        return this.reduce((total, num) => total + (num as number), 0);
+    }
+
+    return this.reduce((total, item) => total + (item[field] as number), 0);
+};
+
 /**
  * Array Utilities
  */