Merge pull request Avocarrot#2 from gadget69/feat/not-equals

feat(operators) add not equals operator

Author: giorgosera

README.md

@@ -60,15 +60,15 @@ A utility library which filters objects from an array of objects based on a set
 
 ```npm install filter-objects```
 
-## Usage 
+## Usage
 
 1. Create a query object by using `query(arr)` where `arr` is the array of objects you want to query.
 
 ```javascript
 const q = query(arr)
 ```
 
-2. Finally get the result array using: 
+2. Finally get the result array using:
 
 ```javascript
 q.every(filters); //returns an array of all objects in `arr` that satisfy EVERY filter
@@ -82,11 +82,11 @@ q.some(filters); //returns an array of all objects in `arr` that satisfy SOME of
 
 `value` - The value of the property we will filter on
 
-`operator` - The filter operator. Supported operators `equals`, `contains`, `gt`, `gte`, `lt`, `lte`
+`operator` - The filter operator. Supported operators `equals`, `contains`, `gt`, `gte`, `lt`, `lte`, `ne`
 
 ## Contributing
 
-This project is work in progress and we'd love more people contributing to it. 
+This project is work in progress and we'd love more people contributing to it.
 
 1. Fork the repo
 2. Apply your changes

lib/operators.js

@@ -6,6 +6,7 @@ const contains = (val1, val2) => {
 };
 
 const equals = (val1, val2) => val1 === val2;
+const ne = (val1, val2) => val1 !== val2;
 const gt = (val1, val2) => val1 > val2;
 const gte = (val1, val2) => val1 >= val2;
 const lt = (val1, val2) => val1 < val2;
@@ -14,8 +15,9 @@ const lte = (val1, val2) => val1 <= val2;
 module.exports = {
   contains,
   equals,
+  ne,
   gt,
-  gte, 
+  gte,
   lt,
   lte
-};
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "query-objects",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A utility library which filters objects from an array of objects based on a set of filter conditions",
   "main": "index.js",
   "scripts": {

test/lib/operators.spec.js

@@ -1,6 +1,7 @@
 const should = require('chai').Should();
 const contains = require('../../lib/operators').contains;
 const equals = require('../../lib/operators').equals;
+const ne = require('../../lib/operators').ne;
 const gt = require('../../lib/operators').gt;
 const gte = require('../../lib/operators').gte;
 const lt = require('../../lib/operators').lt;
@@ -24,6 +25,11 @@ describe('Operators module tests', () => {
     equals(1, 10).should.be.false;
   });
 
+  it('ne(val1, val2) should return true `val1` not equals `val2` otherwise false', () => {
+    ne(1, 1).should.be.false;
+    ne(1, 10).should.be.true;
+  });
+
   it('gt(val1, val2) should return true `val1` is greater than `val2` otherwise false', () => {
     gt(10, 1).should.be.true;
     gt(1, 10).should.be.false;