@mojaloop/ml-number 11.2.7 → 11.3.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [11.3.0](https://github.com/mojaloop/ml-number/compare/v11.2.7...v11.3.0) (2025-07-15)
+
+
+### Features
+
+* added isequal to function ([#40](https://github.com/mojaloop/ml-number/issues/40)) ([40c2a0d](https://github.com/mojaloop/ml-number/commit/40c2a0dc3958d25c942d6288359e7289e45db62e))
+
 ### [11.2.7](https://github.com/mojaloop/ml-number/compare/v11.2.6...v11.2.7) (2025-02-19)
 
 ### [11.2.6](https://github.com/mojaloop/ml-number/compare/v11.2.5...v11.2.6) (2025-01-24)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/ml-number",
-  "version": "11.2.7",
+  "version": "11.3.0",
   "description": "Mojaloop Number Library implementation that handles decimal processing of amounts/numbers",
   "author": "ModusBox",
   "contributors": [
@@ -46,13 +46,13 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "bignumber.js": "9.1.2"
+    "bignumber.js": "9.3.1"
   },
   "devDependencies": {
     "audit-ci": "^7.1.0",
-    "eslint": "9.20.1",
+    "eslint": "9.31.0",
     "faucet": "0.0.4",
-    "npm-check-updates": "17.1.14",
+    "npm-check-updates": "18.0.1",
     "nyc": "17.1.0",
     "pre-commit": "1.2.2",
     "standard": "17.1.2",

package/src/mlnumber.js

@@ -164,6 +164,24 @@ class MLNumber {
   toFixed (decimalPlaces = 4, roundingMode = BigNumber.ROUND_UP) {
     return this.mlNumber.toFixed(decimalPlaces, roundingMode)
   }
+
+  /**
+   * @function isEqualTo
+   *
+   * @description Checks if MLNumber is equal to another value
+   *
+   * @param {string|number|MLNumber} value - Value to compare
+   * @return {boolean} - Returns true if equal, false otherwise
+   */
+  isEqualTo (value) {
+    let compareValue
+    if (value instanceof MLNumber) {
+      compareValue = value.mlNumber
+    } else {
+      compareValue = new BigNumber(value)
+    }
+    return this.mlNumber.isEqualTo(compareValue)
+  }
 }
 
 module.exports = {

package/test/unit/mlnumber.test.js

@@ -182,10 +182,44 @@ test('MLNumber', mlNumberTest => {
     test.end()
   })
 
-  mlNumberTest.test('Create MLNumber with MLNumber variable', test => {
-    const mlNumber = new MLNumber(9)
-    const mlNumber2 = new MLNumber(mlNumber)
-    test.deepEqual(mlNumber, mlNumber2, 'Ml number created from MLNumber are equal')
+  mlNumberTest.test('isEqualTo should compare MLNumber instances', test => {
+    const mlNumber1 = new MLNumber(10)
+    const mlNumber2 = new MLNumber(10)
+    const mlNumber3 = new MLNumber('10')
+    const mlNumber4 = new MLNumber(11)
+    test.ok(mlNumber1.isEqualTo(mlNumber2), 'MLNumber(10) is equal to MLNumber(10)')
+    test.ok(mlNumber1.isEqualTo(mlNumber3), 'MLNumber(10) is equal to MLNumber("10")')
+    test.notOk(mlNumber1.isEqualTo(mlNumber4), 'MLNumber(10) is not equal to MLNumber(11)')
+    test.end()
+  })
+
+  mlNumberTest.test('Native JS decimal math should show binary floating point issue', test => {
+    // This test demonstrates the classic JS decimal issue
+    test.notOk((0.1 + 0.2) === 0.3, 'Native JS (0.1 + 0.2) === 0.3 is false due to floating point error')
+    test.end()
+  })
+
+  mlNumberTest.test('MLNumber should handle decimal math correctly', test => {
+    // This test demonstrates MLNumber (BigNumber) correct handling
+    const mlNumber1 = new MLNumber(0.1)
+    const mlNumber2 = new MLNumber(0.2)
+    const mlNumber3 = new MLNumber(0.3)
+    const sum = mlNumber1.add(mlNumber2)
+    test.ok(sum.isEqualTo(mlNumber3), 'MLNumber(0.1) + MLNumber(0.2) is equal to MLNumber(0.3)')
+    test.end()
+  })
+
+  mlNumberTest.test('isEqualTo should convert non-MLNumber values to BigNumber for comparison', test => {
+    const mlNumber = new MLNumber('123.456')
+    // Compare with string
+    test.ok(mlNumber.isEqualTo('123.456'), 'MLNumber is equal to string value')
+    // Compare with number
+    test.ok(mlNumber.isEqualTo(123.456), 'MLNumber is equal to number value')
+    // Compare with BigNumber directly
+    const BigNumber = require('bignumber.js')
+    test.ok(mlNumber.isEqualTo(new BigNumber('123.456')), 'MLNumber is equal to BigNumber value')
+    // Compare with different value
+    test.notOk(mlNumber.isEqualTo('654.321'), 'MLNumber is not equal to different string value')
     test.end()
   })