@etsoo/shared 1.2.71 → 1.2.72

package/README.md

@@ -276,6 +276,7 @@ Numbers related utilities
 | getCurrencySymbol | Get currency symbol or name from ISO code             |
 |             parse | Parse to number, with or without default value        |
 |           toExact | To the exact precision number avoiding precision lost |
+|            toStep | To the step number, like 0, 10, 20, 30 for step 10    |
 
 ## StorageUtils
 

package/__tests__/NumberUtils.ts

@@ -50,3 +50,12 @@ test("Tests for toFileSize", () => {
   expect(NumberUtils.formatFileSize(1125000)).toBe("1.07 MB");
   expect(NumberUtils.formatFileSize(1125000, 1)).toBe("1.1 MB");
 });
+
+test("Tests for toStep", () => {
+  const nums = [9, 13, 20, 33, 99, 101, 3009];
+  const results = nums.map((num) => num.toStep(10));
+  expect(results).toStrictEqual([0, 10, 20, 30, 90, 100, 3000]);
+
+  const results2 = nums.map((num) => num.toStep(8));
+  expect(results2).toStrictEqual([8, 8, 16, 32, 96, 96, 3008]);
+});

package/lib/cjs/NumberUtils.d.ts

@@ -5,6 +5,11 @@ declare global {
          * @param precision Precision
          */
         toExact(precision?: number): number;
+        /**
+         * To the step number, like 0, 10, 20, 30 for step 10
+         * @param step Step
+         */
+        toStep(step: number): number;
     }
 }
 export declare namespace NumberUtils {

package/lib/cjs/NumberUtils.js

@@ -9,6 +9,11 @@ Number.prototype.toExact = function (precision) {
     const p = Math.pow(10, precision);
     return Math.round(this * p) / p;
 };
+Number.prototype.toStep = function (step) {
+    if (step <= 0)
+        return this;
+    return Math.floor(this / step) * step;
+};
 var NumberUtils;
 (function (NumberUtils) {
     /**

package/lib/mjs/NumberUtils.d.ts

@@ -5,6 +5,11 @@ declare global {
          * @param precision Precision
          */
         toExact(precision?: number): number;
+        /**
+         * To the step number, like 0, 10, 20, 30 for step 10
+         * @param step Step
+         */
+        toStep(step: number): number;
     }
 }
 export declare namespace NumberUtils {

package/lib/mjs/NumberUtils.js

@@ -6,6 +6,11 @@ Number.prototype.toExact = function (precision) {
     const p = Math.pow(10, precision);
     return Math.round(this * p) / p;
 };
+Number.prototype.toStep = function (step) {
+    if (step <= 0)
+        return this;
+    return Math.floor(this / step) * step;
+};
 export var NumberUtils;
 (function (NumberUtils) {
     /**

package/package.json

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

package/src/NumberUtils.ts

@@ -5,6 +5,12 @@ declare global {
      * @param precision Precision
      */
     toExact(precision?: number): number;
+
+    /**
+     * To the step number, like 0, 10, 20, 30 for step 10
+     * @param step Step
+     */
+    toStep(step: number): number;
   }
 }
 
@@ -17,6 +23,12 @@ Number.prototype.toExact = function (this: number, precision?: number) {
   return Math.round(this * p) / p;
 };
 
+Number.prototype.toStep = function (this: number, step: number) {
+  if (step <= 0) return this;
+
+  return Math.floor(this / step) * step;
+};
+
 export namespace NumberUtils {
   /**
    * Format number