@numio/bigmath 1.0.6 → 1.0.7

package/README.md

@@ -113,12 +113,12 @@ const negative = mul(["-2", "3"]); // -6
 ```javascript
 import { div } from "@numio/bigmath";
 
-const int = div(["9999", "33"]); //
+const int = div(["9999", "33"]); // 303
 const float = div(["0.06", "0.2"]); // 0.3
-const negative = div(["-2", "-3", "2"]); // 3
+const negative = div(["-2", "-3", "2"]); //0.33333333333333333333
 
 // set number of digit after the decimal. By default it's 20
-div("10", "3"); // 3.33333
+div(["10", "3"], 4); // 3.3333
 ```
 
 ### Round

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@numio/bigmath",
   "description": "@numio/bigmath is an arbitrary-precision arithmetic library. It can be used for basic operations with decimal numbers (integers and float)",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "keywords": [
     "precision",
     "arithmetic",

package/src/compare/main.d.ts

@@ -2,6 +2,8 @@ import type { CompareRawFn, Max, MaxRawFn, Min, MinRawFn } from "./types.d.ts";
 export declare const compareRawFn: CompareRawFn;
 export declare const maxRawFn: MaxRawFn;
 export declare const minRawFn: MinRawFn;
+/** This function returns max number. */
 export declare const max: Max;
+/** This function returns min number. */
 export declare const min: Min;
 export declare const isGreater: (l: string, r: string) => boolean;

package/src/compare/main.js

@@ -65,10 +65,12 @@ export var minRawFn = function (array) {
     }
     return min;
 };
+/** This function returns max number. */
 export var max = function (strs) {
     var array = strs.map(function (str) { return s2a(str); });
     return a2s(maxRawFn(array));
 };
+/** This function returns min number. */
 export var min = function (strs) {
     var array = strs.map(function (str) { return s2a(str); });
     return a2s(minRawFn(array));

package/src/mean/main.d.ts

@@ -1,2 +1,3 @@
 import type { Mean } from "./types.d.ts";
+/** This function returns mean of an array. */
 export declare const mean: Mean;

package/src/mean/main.js

@@ -1,4 +1,5 @@
 import { pipe } from "../pipe/main.js";
+/** This function returns mean of an array. */
 export var mean = function (array) {
     return pipe.add(array).div([array.length.toString()]).calc();
 };

package/src/pipe/main.d.ts

@@ -9,5 +9,6 @@ declare class Pipe {
     mul(strs: string[]): Pipe;
     calc(): ReturnType<A2S>;
 }
+/** Using this function you can chain operations (add, sub, div, mul). */
 export declare const pipe: Pipe;
 export {};

package/src/pipe/main.js

@@ -32,4 +32,5 @@ var Pipe = /** @class */ (function () {
     };
     return Pipe;
 }());
+/** Using this function you can chain operations (add, sub, div, mul). */
 export var pipe = new Pipe();

package/src/quartile/main.d.ts

@@ -1,2 +1,3 @@
 import type { Quartile } from "./types.d.ts";
+/** This function returns Q1, Q2, Q3 (quartile). */
 export declare const quartile: Quartile;

package/src/quartile/main.js

@@ -2,6 +2,7 @@ import { pipe } from "../pipe/main.js";
 var mean = function (idx, array) {
     return pipe.add([array[idx], array[idx - 1]]).div(["2"]).calc();
 };
+/** This function returns Q1, Q2, Q3 (quartile). */
 export var quartile = function (array) {
     if (array.length < 3) {
         throw Error("To calculate quartile you need at least 3 elements");

package/src/round/index.js

@@ -9,13 +9,13 @@ export var round = function (value, options) {
     var sigFig = (_c = options === null || options === void 0 ? void 0 : options.sigFig) !== null && _c !== void 0 ? _c : false;
     var decimals = (_d = options === null || options === void 0 ? void 0 : options.decimals) !== null && _d !== void 0 ? _d : 0;
     var isFloat = false;
-    var isNill = true;
+    var isNil = true;
     for (var i = 0; i < value.length; i++) {
         var charCode = value.charCodeAt(i);
         if (sigFig && charCode > 48)
             sigFig = false;
-        if (isNill && charCode > 48)
-            isNill = false;
+        if (isNil && charCode > 48)
+            isNil = false;
         if (isFloat && !sigFig)
             decimals -= 1;
         if (charCode === 46)
@@ -39,7 +39,7 @@ export var round = function (value, options) {
         array.push(charCode);
     }
     handleTail(array, isFloat);
-    return (isNill && array[array.length - 1] <= 48)
+    return (isNil && array[array.length - 1] <= 48)
         ? "0"
         : String.fromCharCode.apply(String, array);
 };

package/src/shared/utils.js

@@ -28,8 +28,7 @@ export var a2s = function (_a) {
                 result.push(array[i]);
             }
         }
-        result.at(-1) === 46 && result.pop();
-        return convert(isNegative, result);
+        return result.at(-1) === 46 ? "0" : convert(isNegative, result);
     }
     return convert(isNegative, array);
 };
@@ -38,9 +37,10 @@ export var s2a = function (string) {
     var isNegative = string.charCodeAt(0) === 45;
     var shift = isNegative ? 1 : 0;
     var dec = 0;
-    if ((string.length === 1 && string.charCodeAt(0) === 48) ||
-        string.length === 2 && string.charCodeAt(0) === 45 &&
-            string.charCodeAt(1) === 48) {
+    var isNil = string.length === 1 && string.charCodeAt(0) === 48;
+    var isNegNil = string.length === 2 && string.charCodeAt(0) === 45 &&
+        string.charCodeAt(1) === 48;
+    if (isNil || isNegNil) {
         return {
             array: [48],
             intLength: 1,

package/src/sort/main.d.ts

@@ -1,2 +1,3 @@
 import type { Sort } from "./types.d.ts";
+/** Using this function sort an array. */
 export declare const sort: Sort;

package/src/sort/main.js

@@ -35,6 +35,7 @@ var sortRawFn = function (array, sorting) {
     }
     return array;
 };
+/** Using this function sort an array. */
 export var sort = function (array, sorting) {
     if (sorting === void 0) { sorting = ASC; }
     var inputDataArray = array.map(function (str) { return s2a(str); });