@utiliread/primitives 1.0.0-9 → 1.0.0-91

package/src/number-formatter.spec.ts

@@ -1,77 +1,549 @@
-import { expect } from 'chai';
-import { NumberFormatter } from './number-formatter';
-
-const localeDecimalSeparator = (0.1).toLocaleString()[1];
-
-describe("toLocalePrecision", () => {
-    it("should format correctly", () => {
-        const data: [number, number, string][] = [
-            [77.1274, 1, "8e+1"],
-            [77.1274, 2, "77"],
-            [77.1274, 4, "77.13"],
-            [77.1274, 5, "77.127"],
-            [77.1274, 6, "77.1274"],
-            [77.1274, 7, "77.12740"],
-            [77.1274, 15, "77.1274000000000"],
-            [77.1274, 16, "77.12739999999999"],
-            [77.1274, 17, "77.127399999999994"],
-            [77.1274, 18, "77.1273999999999944"],
-            [77.1274, 19, "77.12739999999999441"],
-            [77.1274, 20, "77.127399999999994407"],
-            [77.1274, 21, "77.1273999999999944066"],
-            [0.00000123, 2, "0.0000012"],
-            [0.000000123, 2, "1.2e-7"],
-            [0.00000123, 21, "0.00000123000000000000008198"],
-            [123456, 3, "1.23e+5"],
-            [Number.MAX_VALUE, 3, "1.80e+308"],
-            [123456, 15, "123456.000000000"],
-            [0, 5, "0.0000"],
-            [0.000001, 1, "0.000001"],
-            [0.000001, 10, "0.000001000000000"],
-            [0.0000001, 10, "1.000000000e-7"],
-            [0.00000000001, 1, "1e-11"],
-            [0.00000000001, 2, "1.0e-11"],
-            [55, 2, "55"],
-            [55, 1, "6e+1"],
-            [-55, 2, "-55"],
-            [-55, 1, "-6e+1"],
-            [9.59, 1, "1e+1"],
-            [9.59, 2, "10"],
-            [9.95, 2, "10"],
-            [9.96, 2, "10"],
-            [-555555555555555555555, 1, "-6e+20"],
-            [-5555555555555555555555, 1, "-6e+21"],
-            [18014398509482012, 21, "18014398509482012.0000"],
-            [180143985094820121234, 21, "180143985094820134912"],
-            [0.1, 21, "0.100000000000000005551"],
-            [Number.EPSILON, 2, "2.2e-16"],
-            [Number.EPSILON, 21, "2.22044604925031308085e-16"],
-            [Number.NaN, 3, "NaN"],
-            [Number.POSITIVE_INFINITY, 3, "Infinity"],
-            [Number.NEGATIVE_INFINITY, 3, "-Infinity"],
-        ];
-
-        for (const [value, precision, expected] of data) {
-            expect(NumberFormatter.toLocalePrecision(value, precision)).to.equal(expected.replace(".", localeDecimalSeparator));
-        }
-    })
-})
-
-describe("toLocaleFixed", () => {
-    it("should format correctly", () => {
-        const data: [number, number, string][] = [
-            [10, 1, "10"],
-            [10, 2, "10"],
-            [10, 3, "10.0"],
-            [10, 4, "10.00"],
-            [10.2, 1, "10"],
-            [10.2, 2, "10"],
-            [10.2, 3, "10.2"],
-            [10.2, 4, "10.20"],
-        ];
-
-        for (const [value, precision, expected] of data) {
-            expect(NumberFormatter.toLocaleFixed(value, precision)).to.equal(expected.replace(".", localeDecimalSeparator));
-        }
-    })
-})
+import {
+    NumberFormatter,
+    Parts,
+    invariantDecimalSeparator,
+    localeDecimalSeparator,
+} from "./number-formatter";
+
+import { expect } from "@esm-bundle/chai";
+
+describe("toParts and toPrecision", () => {
+    it("should format correctly", () => {
+        const data: [number, number, Parts][] = [
+            [
+                0,
+                0,
+                {
+                    invariantPrecisionString: "0",
+                    invariantCoefficientString: "0",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                0.0,
+                1,
+                {
+                    invariantPrecisionString: "0.0",
+                    invariantCoefficientString: "0.0",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 1,
+                },
+            ],
+            [
+                77.1274,
+                1,
+                {
+                    invariantPrecisionString: "8e+1",
+                    invariantCoefficientString: "8",
+                    exponent: 1,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                77.1274,
+                2,
+                {
+                    invariantPrecisionString: "77",
+                    invariantCoefficientString: "77",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                77.1274,
+                4,
+                {
+                    invariantPrecisionString: "77.13",
+                    invariantCoefficientString: "77.13",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 2,
+                },
+            ],
+            [
+                77.1274,
+                5,
+                {
+                    invariantPrecisionString: "77.127",
+                    invariantCoefficientString: "77.127",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 3,
+                },
+            ],
+            [
+                77.1274,
+                6,
+                {
+                    invariantPrecisionString: "77.1274",
+                    invariantCoefficientString: "77.1274",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 4,
+                },
+            ],
+            [
+                77.1274,
+                7,
+                {
+                    invariantPrecisionString: "77.12740",
+                    invariantCoefficientString: "77.12740",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 5,
+                },
+            ],
+            [
+                77.1274,
+                15,
+                {
+                    invariantPrecisionString: "77.1274000000000",
+                    invariantCoefficientString: "77.1274000000000",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 13,
+                },
+            ],
+            [
+                77.1274,
+                16,
+                {
+                    invariantPrecisionString: "77.12739999999999",
+                    invariantCoefficientString: "77.12739999999999",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 14,
+                },
+            ],
+            [
+                77.1274,
+                17,
+                {
+                    invariantPrecisionString: "77.127399999999994",
+                    invariantCoefficientString: "77.127399999999994",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 15,
+                },
+            ],
+            [
+                77.1274,
+                18,
+                {
+                    invariantPrecisionString: "77.1273999999999944",
+                    invariantCoefficientString: "77.1273999999999944",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 16,
+                },
+            ],
+            [
+                77.1274,
+                19,
+                {
+                    invariantPrecisionString: "77.12739999999999441",
+                    invariantCoefficientString: "77.12739999999999441",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 17,
+                },
+            ],
+            [
+                77.1274,
+                20,
+                {
+                    invariantPrecisionString: "77.127399999999994407",
+                    invariantCoefficientString: "77.127399999999994407",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 18,
+                },
+            ],
+            [
+                77.1274,
+                21,
+                {
+                    invariantPrecisionString: "77.1273999999999944066",
+                    invariantCoefficientString: "77.1273999999999944066",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 19,
+                },
+            ],
+            [
+                0.00000123,
+                2,
+                {
+                    invariantPrecisionString: "0.0000012",
+                    invariantCoefficientString: "0.0000012",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 7,
+                },
+            ],
+            [
+                0.000000123,
+                2,
+                {
+                    invariantPrecisionString: "1.2e-7",
+                    invariantCoefficientString: "1.2",
+                    exponent: -7,
+                    noOfCoefficientDecimals: 1,
+                },
+            ],
+            [
+                0.00000123,
+                21,
+                {
+                    invariantPrecisionString: "0.00000123000000000000008198",
+                    invariantCoefficientString: "0.00000123000000000000008198",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 26,
+                },
+            ],
+            [
+                123456,
+                3,
+                {
+                    invariantPrecisionString: "1.23e+5",
+                    invariantCoefficientString: "1.23",
+                    exponent: 5,
+                    noOfCoefficientDecimals: 2,
+                },
+            ],
+            [
+                Number.MAX_VALUE,
+                3,
+                {
+                    invariantPrecisionString: "1.80e+308",
+                    invariantCoefficientString: "1.80",
+                    exponent: 308,
+                    noOfCoefficientDecimals: 2,
+                },
+            ],
+            [
+                123456,
+                15,
+                {
+                    invariantPrecisionString: "123456.000000000",
+                    invariantCoefficientString: "123456.000000000",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 9,
+                },
+            ],
+            [
+                0,
+                5,
+                {
+                    invariantPrecisionString: "0.00000",
+                    invariantCoefficientString: "0.00000",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 5,
+                },
+            ],
+            [
+                0.000001,
+                1,
+                {
+                    invariantPrecisionString: "0.000001",
+                    invariantCoefficientString: "0.000001",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 6,
+                },
+            ],
+            [
+                0.000001,
+                10,
+                {
+                    invariantPrecisionString: "0.000001000000000",
+                    invariantCoefficientString: "0.000001000000000",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 15,
+                },
+            ],
+            [
+                0.0000001,
+                10,
+                {
+                    invariantPrecisionString: "1.000000000e-7",
+                    invariantCoefficientString: "1.000000000",
+                    exponent: -7,
+                    noOfCoefficientDecimals: 9,
+                },
+            ],
+            [
+                0.00000000001,
+                1,
+                {
+                    invariantPrecisionString: "1e-11",
+                    invariantCoefficientString: "1",
+                    exponent: -11,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                0.00000000001,
+                2,
+                {
+                    invariantPrecisionString: "1.0e-11",
+                    invariantCoefficientString: "1.0",
+                    exponent: -11,
+                    noOfCoefficientDecimals: 1,
+                },
+            ],
+            [
+                55,
+                2,
+                {
+                    invariantPrecisionString: "55",
+                    invariantCoefficientString: "55",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                55,
+                1,
+                {
+                    invariantPrecisionString: "6e+1",
+                    invariantCoefficientString: "6",
+                    exponent: 1,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                -55,
+                2,
+                {
+                    invariantPrecisionString: "-55",
+                    invariantCoefficientString: "-55",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                -55,
+                1,
+                {
+                    invariantPrecisionString: "-6e+1",
+                    invariantCoefficientString: "-6",
+                    exponent: 1,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                9.59,
+                1,
+                {
+                    invariantPrecisionString: "1e+1",
+                    invariantCoefficientString: "1",
+                    exponent: 1,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                9.59,
+                2,
+                {
+                    invariantPrecisionString: "10",
+                    invariantCoefficientString: "10",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                9.95,
+                2,
+                {
+                    invariantPrecisionString: "10",
+                    invariantCoefficientString: "10",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                9.96,
+                2,
+                {
+                    invariantPrecisionString: "10",
+                    invariantCoefficientString: "10",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                -555555555555555555555,
+                1,
+                {
+                    invariantPrecisionString: "-6e+20",
+                    invariantCoefficientString: "-6",
+                    exponent: 20,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                -5555555555555555555555,
+                1,
+                {
+                    invariantPrecisionString: "-6e+21",
+                    invariantCoefficientString: "-6",
+                    exponent: 21,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                18014398509482012,
+                21,
+                {
+                    invariantPrecisionString: "18014398509482012.0000",
+                    invariantCoefficientString: "18014398509482012.0000",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 4,
+                },
+            ],
+            [
+                180143985094820121234,
+                21,
+                {
+                    invariantPrecisionString: "180143985094820134912",
+                    invariantCoefficientString: "180143985094820134912",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                0.1,
+                21,
+                {
+                    invariantPrecisionString: "0.100000000000000005551",
+                    invariantCoefficientString: "0.100000000000000005551",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 21,
+                },
+            ],
+            [
+                Number.EPSILON,
+                2,
+                {
+                    invariantPrecisionString: "2.2e-16",
+                    invariantCoefficientString: "2.2",
+                    exponent: -16,
+                    noOfCoefficientDecimals: 1,
+                },
+            ],
+            [
+                Number.EPSILON,
+                21,
+                {
+                    invariantPrecisionString: "2.22044604925031308085e-16",
+                    invariantCoefficientString: "2.22044604925031308085",
+                    exponent: -16,
+                    noOfCoefficientDecimals: 20,
+                },
+            ],
+            [
+                Number.NaN,
+                3,
+                {
+                    invariantPrecisionString: "NaN",
+                    invariantCoefficientString: "NaN",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                Number.POSITIVE_INFINITY,
+                3,
+                {
+                    invariantPrecisionString: "Infinity",
+                    invariantCoefficientString: "Infinity",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                Number.NEGATIVE_INFINITY,
+                3,
+                {
+                    invariantPrecisionString: "-Infinity",
+                    invariantCoefficientString: "-Infinity",
+                    exponent: 0,
+                    noOfCoefficientDecimals: 0,
+                },
+            ],
+            [
+                164735280,
+                7,
+                {
+                    invariantPrecisionString: "1.647353e+8",
+                    invariantCoefficientString: "1.647353",
+                    exponent: 8,
+                    noOfCoefficientDecimals: 6,
+                },
+            ],
+        ];
+
+        for (const [value, precision, expectedParts] of data) {
+            expect(NumberFormatter.toPrecision(value, precision)).to.equal(
+                expectedParts.invariantPrecisionString,
+            );
+
+            const localePrecisionString =
+                expectedParts.invariantPrecisionString.replace(
+                    invariantDecimalSeparator,
+                    localeDecimalSeparator,
+                );
+            expect(
+                NumberFormatter.toLocalePrecision(value, precision),
+            ).to.equal(localePrecisionString);
+
+            const parts = NumberFormatter.getParts(value, precision);
+            expect(parts.invariantPrecisionString).to.equal(
+                expectedParts.invariantPrecisionString,
+            );
+            expect(parts.invariantCoefficientString).to.equal(
+                expectedParts.invariantCoefficientString,
+            );
+            expect(parts.exponent).to.equal(expectedParts.exponent);
+            expect(parts.noOfCoefficientDecimals).to.equal(
+                expectedParts.noOfCoefficientDecimals,
+            );
+        }
+    });
+});
+
+describe("toFixed", () => {
+    it("should format correctly", () => {
+        const data: [number, number, string][] = [
+            [0, 0, "0"],
+            [0.0, 1, "0.0"],
+            [10, 1, "10"],
+            [10, 2, "10"],
+            [10, 3, "10.0"],
+            [10, 4, "10.00"],
+            [10.2, 1, "10"],
+            [10.2, 2, "10"],
+            [10.2, 3, "10.2"],
+            [10.2, 4, "10.20"],
+            [217887000000, 6, "217887000000"],
+        ];
+
+        for (const [value, precision, invariantExpected] of data) {
+            expect(NumberFormatter.toFixed(value, precision)).to.equal(
+                invariantExpected,
+            );
+
+            const localeExpected = invariantExpected.replace(
+                invariantDecimalSeparator,
+                localeDecimalSeparator,
+            );
+            expect(NumberFormatter.toLocaleFixed(value, precision)).to.equal(
+                localeExpected,
+            );
+        }
+    });
+});
+
+describe("toLocaleFixed", () => {
+    it("should format correctly", () => {
+        expect(NumberFormatter.toLocaleFixed(400, 2)).to.equal("400");
+    });
+
+    it("should format correctly with max decimals", () => {
+        expect(NumberFormatter.toLocaleFixed(35.123456, 8, 2)).to.equal(
+            "35.12",
+        );
+        expect(NumberFormatter.toLocaleFixed(35.129999, 8, 2)).to.equal(
+            "35.13",
+        );
+    });
+});