Parameters

1. filter {Object}:

   The filter property is an object of property names to values like:

   {
       filter: {
           age: {$gt: 21},
           name: ["Justin","Ramiya"]
       }
   }
   

   The Comparison Operators ($eq, $gt, $gte, $in, $lt, $lte, $ne, $nin) are available within filter.

2. sort {String}:

   The sort property is an optional value specifying:

   • the property used to sort the results of a query, and
   • the direction of the sort (start the value with - for descending).

   The sort property is specified as a string like sort: "age". sort: "age" will return results ascending by the age property. sort: "-age" will return results descending by the age property.

   This format follows JSON API's recommendations on sorting. However, can-query-logic can only sort by a single property currently.

   The sort property defaults to "ID_PROPERTY" where ID_PROPERTY is the first identity property returned by identityKeys. This is usually the first identity value on the schema passed to new QueryLogic():

   new QueryLogic({
       identity: ["_id"]
   }).identityKeys() //-> ["_id"]
   

3. page {Object}:

   The optional page property selects a range of the sorted result. It's values are inclusive and begin at 0. This means that:

   • {start: 0, end: 1} - Selects the first two records in the result.
   • {start: 10, end: 19} - Selects 10 records after the first 10 records.

   The start value defaults to 0 and the end value defaults to Infinity. This means that:

   • {end: 99} - Selects the first 100 records.
   • {start: 100} - Selects all records after the first 100.