refactor(api) Changes exposed function names for clarity (Avocarrot#3)

Author: giorgosera

README.md

@@ -7,7 +7,7 @@
 A utility library which filters objects from an array of objects based on a set of filter conditions.
 
 ```javascript
-  const query = require('query-objects');
+  const queryable = require('query-objects');
 
   const users = [
     {
@@ -41,10 +41,10 @@ A utility library which filters objects from an array of objects based on a set
   ];
 
   // Filter all users that are less than 30 years old AND their first name is Erica
-  const res = query(users).every(filters);
+  const res = queryable(users).and(filters);
 
   // Filter all users that are less than 30 years old OR their first name is Erica
-  const res = query(users).some(filters);
+  const res = queryable(users).or(filters);
 
 ```
 
@@ -62,18 +62,18 @@ A utility library which filters objects from an array of objects based on a set
 
 ## Usage
 
-1. Create a query object by using `query(arr)` where `arr` is the array of objects you want to query.
+1. Create a queryable object using `queryable(arr)` where `arr` is the array of objects you want to query.
 
 ```javascript
-const q = query(arr)
+const q = queryable(arr);
 ```
 
 2. Finally get the result array using:
 
 ```javascript
-q.every(filters); //returns an array of all objects in `arr` that satisfy EVERY filter
+q.and(filters); //returns an array of all objects in `arr` that satisfy EVERY filter
 
-q.some(filters); //returns an array of all objects in `arr` that satisfy SOME of the filters
+q.or(filters); //returns an array of all objects in `arr` that satisfy SOME of the filters
 ```
 
 ## Filters

lib/index.js

@@ -5,7 +5,7 @@ module.exports = (arr) => {
     throw new Error('`arr` must be an array of objects');
   }
   return {
-    every: filters => filterArr(arr, filters, 'every'),
-    some: filters => filterArr(arr, filters, 'some'),
+    and: filters => filterArr(arr, filters, 'every'),
+    or: filters => filterArr(arr, filters, 'some'),
   };
-}
+};

test/lib/index.spec.js

@@ -1,5 +1,5 @@
 const should = require('chai').Should();
-const query = require('../../lib');
+const queryable = require('../../lib');
 
 describe('Module Tests', () => {
 
@@ -26,26 +26,26 @@ describe('Module Tests', () => {
     }
   ];
 
-  it('query(arr) should return a query object', () => {
-    query([]).should.have.property('every');
-    query([]).should.have.property('some');
+  it('queryable(arr) should return a queryable object', () => {
+    queryable([]).should.have.property('and');
+    queryable([]).should.have.property('or');
   });
 
   it('throw an error if `arr` is not an array', () => {
     (() => {
-      query();
+      queryable();
     }).should.throw('`arr` must be an array of objects');
 
     (() => { 
-      query('this is a string');
+      queryable('this is a string');
     }).should.throw('`arr` must be an array of objects');
 
     (() => { 
-      query(1234);
+      queryable(1234);
     }).should.throw('`arr` must be an array of objects');
   });
 
-  it('query(arr).every(filters) should return all results that satisfy all filters', () => {
+  it('queryable(arr).and(filters) should return all results that satisfy all filters', () => {
     const filters = [
       {
         field: 'name',
@@ -59,10 +59,10 @@ describe('Module Tests', () => {
       }
     ];
     const expected = [people[0]];
-    query(people).every(filters).should.eql(expected);
+    queryable(people).and(filters).should.eql(expected);
   });
 
-  it('query(arr).some(filters) should return all results that satisfy at least one of the filters', () => {
+  it('queryable(arr).or(filters) should return all results that satisfy at least one of the filters', () => {
     const filters = [
       {
         field: 'name',
@@ -76,7 +76,7 @@ describe('Module Tests', () => {
       }
     ];
     const expected = [people[0], people[1], people[2]];
-    query(people).some(filters).should.eql(expected);
+    queryable(people).or(filters).should.eql(expected);
   });
 
 });