Merge pull request #144 from nutboltu/feat/rm

MikeMcl · web-flow · commit b14a15f25b57 · 2020-09-07T23:10:02.000+01:00
feat: add rm support to strigify and uglify-js as package dependencies
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/big.js b/big.js
@@ -251,8 +251,9 @@
    *         4 valueOf
    * n? {number|undefined} Caller's argument.
    * k? {number|undefined}
+   * rm? 0, 1, 2 or 3 (ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN, ROUND_UP)
    */
-  function stringify(x, id, n, k) {
+  function stringify(x, id, n, k, rm) {
     var e, s,
       Big = x.constructor,
       z = !x.c[0];
@@ -268,7 +269,7 @@
       n = k - x.e;
 
       // Round?
-      if (x.c.length > ++k) round(x, n, Big.RM);
+      if (x.c.length > ++k) round(x, n, rm === undefined ? Big.RM : rm);
 
       // toFixed: recalculate k as x.e may have changed if value rounded up.
       if (id == 2) k = x.e + n + 1;
@@ -865,9 +866,10 @@
    * places and rounded using Big.RM.
    *
    * dp? {number} Integer, 0 to MAX_DP inclusive.
+   * rm? 0, 1, 2 or 3 (ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN, ROUND_UP)
    */
-  P.toExponential = function (dp) {
-    return stringify(this, 1, dp, dp);
+  P.toExponential = function (dp, rm) {
+    return stringify(this, 1, dp, dp, rm);
   };
 
 
@@ -876,12 +878,13 @@
    * places and rounded using Big.RM.
    *
    * dp? {number} Integer, 0 to MAX_DP inclusive.
-   *
+   * rm? 0, 1, 2 or 3 (ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN, ROUND_UP)
+   * 
    * (-0).toFixed(0) is '0', but (-0.1).toFixed(0) is '-0'.
    * (-0).toFixed(1) is '0.0', but (-0.01).toFixed(1) is '-0.0'.
    */
-  P.toFixed = function (dp) {
-    return stringify(this, 2, dp, this.e + dp);
+  P.toFixed = function (dp, rm) {
+    return stringify(this, 2, dp, this.e + dp, rm);
   };
 
 
@@ -891,9 +894,10 @@
    * the integer part of the value in normal notation.
    *
    * sd {number} Integer, 1 to MAX_DP inclusive.
+   * rm? 0, 1, 2 or 3 (ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN, ROUND_UP)
    */
-  P.toPrecision = function (sd) {
-    return stringify(this, 3, sd, sd - 1);
+  P.toPrecision = function (sd, rm) {
+    return stringify(this, 3, sd, sd - 1, rm);
   };
 
 
diff --git a/doc/bigAPI.html b/doc/bigAPI.html
@@ -656,10 +656,14 @@ <h5 id="times">
 
 
     <h5 id="toE">
-      toExponential<code class='inset'>.toExponential(dp) &rArr;
+      toExponential<code class='inset'>.toExponential(dp, rm) &rArr;
       <i>string</i></code>
     </h5>
-    <p><code>dp</code>? : <i>number</i> : integer, 0 to 1e+6 inclusive</p>
+    <p>
+      <code>dp</code>? : <i>number</i> : integer, 0 to 1e+6 inclusive
+      <br />
+      <code>rm</code>? : <i>number</i> : 0, 1, 2 or 3
+    </p>
     <p>
       Returns a string representing the value of this Big number in exponential
       notation to a fixed number of <code>dp</code> decimal places.
@@ -668,7 +672,7 @@ <h5 id="toE">
       If the value of this Big number in exponential notation has more digits to
       the right of the decimal point than is specified by <code>dp</code>, the
       return value will be rounded to <code>dp</code> decimal places using
-      rounding mode <a href='#rm'><code>Big.RM</code></a>.
+      rounding mode <a href='#rm'><code>rm</code></a>.
     </p>
     <p>
       If the value of this Big number in exponential notation has fewer digits
@@ -678,10 +682,12 @@ <h5 id="toE">
     <p>
       If <code>dp</code> is omitted or is undefined, the number of digits
       after the decimal point defaults to the minimum number of digits
-      necessary to represent the value exactly.
+      necessary to represent the value exactly.<br />
+      if <code>rm</code> is omitted or is undefined, the current
+      <a href='#rm'><code>Big.RM</code></a> setting is used.
     </p>
     <p>
-      Throws if <code>dp</code> is invalid.
+      Throws if <code>dp</code> or <code>rm</code> is invalid.
     </p>
     <pre>
 x = 45.6
@@ -698,11 +704,13 @@ <h5 id="toE">
 
 
     <h5 id="toF">
-      toFixed<code class='inset'>.toFixed(dp) &rArr;
+      toFixed<code class='inset'>.toFixed(dp, rm) &rArr;
       <i>string</i></code>
     </h5>
     <p>
       <code>dp</code>? : <i>number</i> : integer, 0 to 1e+6 inclusive
+      <br />
+      <code>rm</code>? : <i>number</i> : 0, 1, 2 or 3
     </p>
     <p>
       Returns a string representing the value of this Big number in normal
@@ -712,7 +720,7 @@ <h5 id="toF">
       If the value of this Big number in normal notation has more digits to the
       right of the decimal point than is specified by <code>dp</code>, the
       return value will be rounded to <code>dp</code> decimal places using
-      rounding mode <a href='#rm'><code>Big.RM</code></a>.
+      rounding mode <a href='#rm'><code>rm</code></a>.
     </p>
     <p>
       If the value of this Big number in normal notation has fewer fraction
@@ -728,10 +736,12 @@ <h5 id="toF">
       If <code>dp</code> is omitted or is undefined, the return value is
       simply the value in normal notation. This is also unlike
       <code>Number.prototype.toFixed</code>, which returns the value to zero
-      decimal places.
+      decimal places.<br />
+      if <code>rm</code> is omitted or is undefined, the current
+      <a href='#rm'><code>Big.RM</code></a> setting is used.
     </p>
     <p>
-      Throws if <code>dp</code> is invalid.
+      Throws if <code>dp</code> or <code>rm</code> is invalid.
     </p>
     <pre>
 x = 45.6
@@ -745,10 +755,14 @@ <h5 id="toF">
 
 
     <h5 id="toP">
-      toPrecision<code class='inset'>.toPrecision(sd) &rArr;
+      toPrecision<code class='inset'>.toPrecision(sd, rm) &rArr;
       <i>string</i></code>
     </h5>
-    <p><code>sd</code>? : <i>number</i> : integer, 1 to 1e+6 inclusive</p>
+    <p>
+      <code>sd</code>? : <i>number</i> : integer, 1 to 1e+6 inclusive
+      <br />
+      <code>rm</code>? : <i>number</i> : 0, 1, 2 or 3
+    </p>
     <p>
       Returns a string representing the value of this Big number to the
       specified number of <code>sd</code> significant digits.
@@ -757,7 +771,7 @@ <h5 id="toP">
       If the value of this Big number has more digits than is specified by
       <code>sd</code>, the return value will be rounded to <code>sd</code>
       significant digits using rounding mode
-      <a href='#rm'><code>Big.RM</code></a>.
+      <a href='#rm'><code>rm</code></a>.
     </p>
     <p>
       If the value of this Big number has fewer digits than is specified by
@@ -770,10 +784,12 @@ <h5 id="toP">
     </p>
     <p>
       If <code>sd</code> is omitted or is undefined, the return value is
-      the same as <code>.toString()</code>.
+      the same as <code>.toString()</code>.<br />
+      if <code>rm</code> is omitted or is undefined, the current
+      <a href='#rm'><code>Big.RM</code></a> setting is used.
     </p>
     <p>
-      Throws if <code>sd</code> is invalid.
+      Throws if <code>sd</code> or <code>rm</code> is invalid.
     </p>
     <pre>
 x = 45.6
diff --git a/package.json b/package.json
@@ -46,5 +46,8 @@
   "collective": {
     "type": "opencollective",
     "url": "https://opencollective.com/bigjs"
+  },
+  "devDependencies": {
+    "uglify-js": "^3.10.2"
   }
-}
+}
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+uglify-js@^3.10.2:
+  version "3.10.2"
+  resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.10.2.tgz#8cfa1209fd04199cc8a7f9930ddedb30b0f1912d"
+  integrity sha512-GXCYNwqoo0MbLARghYjxVBxDCnU0tLqN7IPLdHHbibCb1NI5zBkU2EPcy/GaVxc0BtTjqyGXJCINe6JMR2Dpow==
