@rinxun/numeric-calculator 1.0.1 → 1.0.4

package/README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Numeric Calculator</h1>
 
-<p align="center">Calculate addition, subtaction, multiplication, division precisely, for tackling the precision issue</p>
+<p align="center">Calculate addition, subtraction, multiplication, division precisely, for tackling the precision issue</p>
 
 ---
 
@@ -48,6 +48,7 @@ This project is licensed under the terms of the [MIT license](https://github.com
 
     - ```js
       config = {
+        precision?: number, // global precision, default to 15
         enableCheckBoundary?: boolean // if true, it will check if the value is out of the safe boundary
       }
       ```
@@ -94,7 +95,7 @@ const inst5 = new NC(10, { enableCheckBoundary: true });
 
 
 
-<h4>inst.plus</h4>
+<h4>inst.plus(operands: IOperand[])</h4>
 
 ```typescript
 const result = new NC().plus(2.134).toPrecision(); // 2.134
@@ -105,7 +106,7 @@ const result = new NC(10).plus(2.1341, '3.09', 0.65).toPrecision(); // => 10+2.1
 
 
 
-<h4>inst.minus</h4>
+<h4>inst.minus(operands: IOperand[])</h4>
 
 ```typescript
 const result = new NC().minus(0.4).toPrecision(); // 0.4
@@ -116,7 +117,7 @@ const result = new NC(-2).minus(0.25, 1.5, 3.498).toPrecision(); // -2-0.25-1.5-
 
 
 
-<h4>inst.times</h4>
+<h4>inst.times(operands: IOperand[])</h4>
 
 ```typescript
 const result = new NC().times(0.12).toPrecision(); // 0.12
@@ -127,7 +128,7 @@ const result = new NC(3.2).times(0.12, '100', 5).toPrecision(); // => 3.2*0.12*1
 
 
 
-<h4>inst.divide</h4>
+<h4>inst.divide(operands: IOperand[])</h4>
 
 ```typescript
 const result = new NC().divide(3).toPrecision(); // 3
@@ -138,7 +139,7 @@ const result = new NC(-1000).divide(100, '20', 2).toPrecision(); // -1000/100/20
 
 
 
-<h4>inst.toPrecision</h4>
+<h4>inst.toPrecision(precision?: number)</h4>
 
 ```typescript
 const result = new NC(1.2345).toPrecision(); // 1.2345
@@ -157,3 +158,6 @@ const result = new NC(10).plus(new NC().times(2, 4), '6').divide(new NC(12).minu
 
 
 
+<h2>Changelog</h2>
+
+If you have recently updated, please read the [changelog](https://github.com/rinxun/numeric-calculator/releases) for details of what has changed.

package/index.d.ts

@@ -1,4 +1,5 @@
 declare type IConfig = {
+    precision?: number;
     enableCheckBoundary?: boolean;
 };
 declare type IOperand = Calculator | number | string;
@@ -13,6 +14,7 @@ declare class Calculator {
      * @description global register for temporary results, core for chaining operations
      */
     private _VALUE;
+    private _precision;
     /**
      * @private
      * @description for debugging, if true, it will check if the value is out of the safe boundary
@@ -71,8 +73,8 @@ declare class Calculator {
     private calculate;
     /**
      * @constructor
-     * @param {IOperand|undefined} operand initial operand
-     * @param {Config} config Configurations
+     * @param {IOperand|undefined} operand Initial operand
+     * @param {IConfig|undefined} config Configurations
      */
     constructor(operand?: IOperand, config?: IConfig);
     /**

package/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -7,6 +8,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
+Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * @description Calculate addition, subtaction, multiplication, division precisely, for tackling the precision issue
  * @author Janden Ma
@@ -17,8 +19,8 @@ var Calculator = /** @class */ (function () {
     // #region Constructor
     /**
      * @constructor
-     * @param {IOperand|undefined} operand initial operand
-     * @param {Config} config Configurations
+     * @param {IOperand|undefined} operand Initial operand
+     * @param {IConfig|undefined} config Configurations
      */
     function Calculator(operand, config) {
         // #region Private Variables
@@ -27,6 +29,7 @@ var Calculator = /** @class */ (function () {
          * @description global register for temporary results, core for chaining operations
          */
         this._VALUE = undefined;
+        this._precision = 15;
         /**
          * @private
          * @description for debugging, if true, it will check if the value is out of the safe boundary
@@ -36,6 +39,9 @@ var Calculator = /** @class */ (function () {
             this._VALUE = this.parseOperandToNum(operand);
         }
         if (config) {
+            if (config.precision !== undefined) {
+                this._precision = config.precision;
+            }
             if (config.enableCheckBoundary) {
                 this._enableCheckBoundary = config.enableCheckBoundary;
             }
@@ -89,7 +95,7 @@ var Calculator = /** @class */ (function () {
      * @param {number} precision default 15
      */
     Calculator.prototype.processPrecision = function (num, precision) {
-        return +parseFloat(num.toPrecision(precision || 15));
+        return +parseFloat(num.toPrecision(precision || this._precision || 15));
     };
     /**
      * core processor for times
@@ -261,4 +267,4 @@ var Calculator = /** @class */ (function () {
     };
     return Calculator;
 }());
-export default Calculator;
+exports.default = Calculator;

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@rinxun/numeric-calculator",
-  "version": "1.0.1",
-  "description": "Calculate addition, subtaction, multiplication, division precisely, for tackling the precision issue",
+  "version": "1.0.4",
+  "description": "Calculate addition, subtraction, multiplication, division precisely, for tackling the precision issue",
   "keywords": [
     "long",
+    "float",
+    "decimal",
     "numeric",
-    "percision",
-    "calculator"
+    "precision",
+    "calculator",
+    "addition",
+    "subtraction",
+    "multiplication",
+    "division"
   ],
   "main": "index.js",
-  "type": "module",
   "types": "**/*.d.ts",
   "license": "MIT",
   "private": false,
@@ -37,7 +42,6 @@
   "files": [
     "*.js",
     "*.d.ts",
-    ".gitignore",
     "package.json",
     "README.md",
     "LICENSE"

package/.gitignore

@@ -1,15 +0,0 @@
-node_modules
-package-lock.json
-yarn.lock
-.vscode
-.DS_Store
-/coverage
-/.pnp
-.pnp.js
-/build
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-*.js
-*.d.ts
-dist