alib-aquery v1.0.6

alib-aquery

alib-aquery is a high performance, chainable array querying library that is extensible to support any type of filtering. It supports filter (in place of where), limit, offset and order by. It is inspired by the SQL SELECT statement but for arrays of objects.

Install

Install with npm:

$ npm i alib-aquery --save

Usage

import or require:

const aquery = require("alib-aquery");

//or

import aquery from "alib-aquery";

Then:

var data = [
  { color: "blue", size: 44 },
  { color: "green", size: 12 },
  { color: "red", size: 18 },
  { color: "blue", size: 9 },
  { color: "blue", size: 4 },
  { color: "blue", size: 12 },
  { color: "black", size: 12 },
];

var result = aquery(data)
  .filter("size", "gt", 10)
  .run();
// return an array of items having the prop 'size' greater than 10
// [
//     { color: 'blue', size: 44 },
//     { color: 'green', size: 12 },
//     { color: 'red', size: 18 },
//     { color: 'blue', size: 12 },
//     { color: 'black', size: 12 },
// ]

var result = aquery(data)
  .filter("size", "gt", 10)
  .filter("color", "eq", "blue")
  .run();
// return an array of items having the prop 'size' greater than 10 and color blue:
// [
//     { color: 'blue', size: 44 },
//     { color: 'blue', size: 12 },
// ]

var result = aquery(data)
  .filter("size", "gt", 10)
  .orderBy("size", "desc")
  .run();
// return an array of items having the prop 'size' greater than 10 ordered by size descending:
// [
//     { color: 'green', size: 12 },
//     { color: 'blue', size: 12 },
//     { color: 'black', size: 12 },
//     { color: 'red', size: 18 },
//     { color: 'blue', size: 44 },
// ]

var result = aquery(data)
  .filter("size", "gt", 10)
  .orderBy("size", "asc")
  .run();
// return an array of items having the prop 'size' greater than 10 ordered by size ascending:
// [
//     { color: 'blue', size: 44 },
//     { color: 'red', size: 18 },
//     { color: 'green', size: 12 },
//     { color: 'blue', size: 12 },
//     { color: 'black', size: 12 },
// ]

var result = aquery(data)
  .filter("size", "gt", 10)
  .orderBy("size", "asc")
  .offset(1)
  .limit(2)
  .run();
// return an array of items having the prop 'size' greater than 10 ordered by size ascending with an offset and limit:
// [
//     { color: 'red', size: 18 },
//     { color: 'green', size: 12 },
// ]

Built in filter functions are:

• eq - equals
• gt - greater than
• lt - less than
• contains - string contains

You can register your own filter function:

aquery().registerFilter("lengthof", (prop, value) => {
  return prop.length === value ? true : false;
});

You can then use your filter function as follows:

var result = aquery(data3)
  .filter("color", "lengthof", 3)
  .run();
// return an array of items having the prop 'color' with a string length of 3:
// [
//     { color: 'red', size: 18 },
// ]