@augment-vir/common 21.5.1 → 21.6.0

package/dist/cjs/augments/common-number.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureMinAndMax = exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.clamp = exports.addCommasToNumber = exports.NaNString = void 0;
+exports.clamp = exports.round = exports.wrapNumber = exports.toEnsuredNumber = exports.ensureMinAndMax = exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.addCommasToNumber = exports.NaNString = void 0;
 const common_string_1 = require("./common-string");
 const regexp_1 = require("./regexp");
 exports.NaNString = String(NaN);
@@ -25,15 +25,6 @@ function addCommasToNumber(input) {
     ].join('');
 }
 exports.addCommasToNumber = addCommasToNumber;
-function clamp(
-/**
- * This uses a destructured object so that consumers cannot get confused as to which input is
- * which (which would be easy to do since they're all of the same type).
- */
-{ value, min, max, }) {
-    return Math.max(Math.min(value, max), min);
-}
-exports.clamp = clamp;
 function convertIntoNumber(input) {
     if (typeof input === 'number') {
         return input;
@@ -63,3 +54,41 @@ function ensureMinAndMax({ min, max }) {
     }
 }
 exports.ensureMinAndMax = ensureMinAndMax;
+function toEnsuredNumber(input) {
+    const numeric = Number(input);
+    if (isNaN(numeric)) {
+        throw new Error(`Cannot convert given input to a number: ${input}`);
+    }
+    else {
+        return numeric;
+    }
+}
+exports.toEnsuredNumber = toEnsuredNumber;
+/**
+ * If the given value is outside the given min/max bounds, instead of clamping the number (as the
+ * `clamp` function does), this function wraps the value around to the next bound.
+ *
+ * @example
+ *     wrapNumber({min: 0, max: 100, value: 101}) == 0;
+ */
+function wrapNumber({ max, min, value }) {
+    if (value > max) {
+        return min;
+    }
+    else if (value < min) {
+        return max;
+    }
+    return value;
+}
+exports.wrapNumber = wrapNumber;
+function round(inputs) {
+    const digitFactor = Math.pow(10, inputs.digits);
+    const multiplied = inputs.number * digitFactor;
+    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
+}
+exports.round = round;
+/** Clamp's the given value to within the min and max bounds, inclusive. */
+function clamp({ value, min, max }) {
+    return Math.min(Math.max(value, min), max);
+}
+exports.clamp = clamp;

package/dist/cjs/augments/string/suffixes.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeSuffix = exports.addSuffix = exports.removePercent = exports.addPercent = exports.removePx = exports.addPx = exports.pxSuffix = exports.percentSuffix = void 0;
-const number_1 = require("../number");
+const common_number_1 = require("../common-number");
 exports.percentSuffix = '%';
 exports.pxSuffix = 'px';
 function addPx(input) {
@@ -9,7 +9,7 @@ function addPx(input) {
 }
 exports.addPx = addPx;
 function removePx(input) {
-    return (0, number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.pxSuffix }));
+    return (0, common_number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.pxSuffix }));
 }
 exports.removePx = removePx;
 function addPercent(input) {
@@ -17,7 +17,7 @@ function addPercent(input) {
 }
 exports.addPercent = addPercent;
 function removePercent(input) {
-    return (0, number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.percentSuffix }));
+    return (0, common_number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.percentSuffix }));
 }
 exports.removePercent = removePercent;
 function addSuffix({ value, suffix, }) {

package/dist/cjs/index.js

@@ -26,7 +26,6 @@ __exportStar(require("./augments/function"), exports);
 __exportStar(require("./augments/json"), exports);
 __exportStar(require("./augments/json-compatible"), exports);
 __exportStar(require("./augments/map"), exports);
-__exportStar(require("./augments/number"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
 __exportStar(require("./augments/object/has-key"), exports);

package/dist/esm/augments/common-number.js

@@ -21,14 +21,6 @@ export function addCommasToNumber(input) {
         decimalString,
     ].join('');
 }
-export function clamp(
-/**
- * This uses a destructured object so that consumers cannot get confused as to which input is
- * which (which would be easy to do since they're all of the same type).
- */
-{ value, min, max, }) {
-    return Math.max(Math.min(value, max), min);
-}
 export function convertIntoNumber(input) {
     if (typeof input === 'number') {
         return input;
@@ -55,3 +47,37 @@ export function ensureMinAndMax({ min, max }) {
         return { min, max };
     }
 }
+export function toEnsuredNumber(input) {
+    const numeric = Number(input);
+    if (isNaN(numeric)) {
+        throw new Error(`Cannot convert given input to a number: ${input}`);
+    }
+    else {
+        return numeric;
+    }
+}
+/**
+ * If the given value is outside the given min/max bounds, instead of clamping the number (as the
+ * `clamp` function does), this function wraps the value around to the next bound.
+ *
+ * @example
+ *     wrapNumber({min: 0, max: 100, value: 101}) == 0;
+ */
+export function wrapNumber({ max, min, value }) {
+    if (value > max) {
+        return min;
+    }
+    else if (value < min) {
+        return max;
+    }
+    return value;
+}
+export function round(inputs) {
+    const digitFactor = Math.pow(10, inputs.digits);
+    const multiplied = inputs.number * digitFactor;
+    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
+}
+/** Clamp's the given value to within the min and max bounds, inclusive. */
+export function clamp({ value, min, max }) {
+    return Math.min(Math.max(value, min), max);
+}

package/dist/esm/augments/string/suffixes.js

@@ -1,4 +1,4 @@
-import { toEnsuredNumber } from '../number';
+import { toEnsuredNumber } from '../common-number';
 export const percentSuffix = '%';
 export const pxSuffix = 'px';
 export function addPx(input) {

package/dist/esm/index.js

@@ -10,7 +10,6 @@ export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/map';
-export * from './augments/number';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';

package/dist/types/augments/common-number.d.ts

@@ -1,15 +1,5 @@
 export declare const NaNString: string;
 export declare function addCommasToNumber(input: number | string): string;
-export declare function clamp(
-/**
- * This uses a destructured object so that consumers cannot get confused as to which input is
- * which (which would be easy to do since they're all of the same type).
- */
-{ value, min, max, }: {
-    value: number;
-    min: number;
-    max: number;
-}): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
 /**
@@ -23,3 +13,31 @@ export declare function ensureMinAndMax({ min, max }: {
     min: number;
     max: number;
 };
+export declare function toEnsuredNumber(input: any): number;
+/**
+ * If the given value is outside the given min/max bounds, instead of clamping the number (as the
+ * `clamp` function does), this function wraps the value around to the next bound.
+ *
+ * @example
+ *     wrapNumber({min: 0, max: 100, value: 101}) == 0;
+ */
+export declare function wrapNumber({ max, min, value }: {
+    value: number;
+    max: number;
+    min: number;
+}): number;
+export declare function round(inputs: {
+    number: number;
+    digits: number;
+}): number;
+/** Clamp's the given value to within the min and max bounds, inclusive. */
+export declare function clamp({ value, min, max }: {
+    value: number;
+    min: number;
+    max: number;
+}): number;
+/** Standard box dimensions. */
+export type Dimensions = {
+    width: number;
+    height: number;
+};

package/dist/types/index.d.ts

@@ -10,7 +10,6 @@ export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/map';
-export * from './augments/number';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "21.5.1",
+    "version": "21.6.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"

package/dist/cjs/augments/number.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.round = exports.wrapNumber = exports.toEnsuredNumber = void 0;
-function toEnsuredNumber(input) {
-    const numeric = Number(input);
-    if (isNaN(numeric)) {
-        throw new Error(`Cannot convert given input to a number: ${input}`);
-    }
-    else {
-        return numeric;
-    }
-}
-exports.toEnsuredNumber = toEnsuredNumber;
-function wrapNumber({ max, min, value }) {
-    if (value > max) {
-        return min;
-    }
-    else if (value < min) {
-        return max;
-    }
-    return value;
-}
-exports.wrapNumber = wrapNumber;
-function round(inputs) {
-    const digitFactor = Math.pow(10, inputs.digits);
-    const multiplied = inputs.number * digitFactor;
-    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
-}
-exports.round = round;

package/dist/esm/augments/number.js

@@ -1,23 +0,0 @@
-export function toEnsuredNumber(input) {
-    const numeric = Number(input);
-    if (isNaN(numeric)) {
-        throw new Error(`Cannot convert given input to a number: ${input}`);
-    }
-    else {
-        return numeric;
-    }
-}
-export function wrapNumber({ max, min, value }) {
-    if (value > max) {
-        return min;
-    }
-    else if (value < min) {
-        return max;
-    }
-    return value;
-}
-export function round(inputs) {
-    const digitFactor = Math.pow(10, inputs.digits);
-    const multiplied = inputs.number * digitFactor;
-    return Number((Math.round(multiplied) / digitFactor).toFixed(inputs.digits));
-}

package/dist/types/augments/number.d.ts

@@ -1,10 +0,0 @@
-export declare function toEnsuredNumber(input: any): number;
-export declare function wrapNumber({ max, min, value }: {
-    value: number;
-    max: number;
-    min: number;
-}): number;
-export declare function round(inputs: {
-    number: number;
-    digits: number;
-}): number;