#303 added equals method to currency object

docs/04-api.md

@@ -70,6 +70,17 @@ Divides the current currency instance by `number`.
 currency(123.45).divide(2); // => "61.73"
 ```
 
+### equals
+
+`currency.equals( number|currency )`
+
+Compares the current currency's value to another currency or `number` value.
+
+```js
+currency(123.45).equals(currency(123.45)); // => true
+currency(10).equals(10); // => true
+```
+
 ### distribute
 
 `currency.distribute( number )`

src/currency.js

@@ -146,6 +146,21 @@ currency.prototype = {
     return currency(intValue /= parse(number, _settings, false), _settings);
   },
 
+  /**
+   * Compares value to another currency instance's value
+   * @param {number|currency} foreign 
+   * @returns {boolean}
+   */
+  equals(foreign) {
+    let { value } = this;
+    if (foreign instanceof currency) {
+      let { value: foreignValue } = foreign;
+
+      return value === foreignValue;
+    }
+    return foreign === value;
+  },
+
   /**
    * Takes the currency amount and distributes the values evenly. Any extra pennies
    * left over from the distribution will be stacked onto the first set of entries.

test/test.js

@@ -555,4 +555,15 @@ test('should handle fractional cents', t => {
   var values = currency(1234.56, { fromCents: true });
   t.is(values.intValue, 1235);
   t.is(values.value, 12.35);
+});
+
+test('equals', t => {
+  let c1 = currency(2.52).subtract(.01);
+  let c2 = currency(2.50).add(.01);
+  let c3 = currency(10);
+
+  t.is(c1.equals(c2), true);
+  t.is(c3.equals(c1), false);
+  t.is(c3.equals(10), true);
+  t.is(c3.equals(10.0), true);
 });