gaiety/json-query-chain
gaiety/json-query-chain
1
1
Fork 0
Code Issues 1 Pull requests 2 Projects Releases Packages Activity Actions
Chain queries onto POJOs to return precise results.
20 commits 4 branches 5 tags 106 KiB
Find a file
sharpshark28 a53e88ac9e Coverage badge
2018-02-22 18:45:22 -06:00
.codeclimate.yml Code climate yml 2017-08-20 21:12:18 -05:00
.gitignore Coverage badge 2018-02-22 18:45:22 -06:00
.travis.yml Code climate fixes, travis config, badge 2017-08-20 20:21:44 -05:00
coverage.svg Coverage badge 2018-02-22 18:45:22 -06:00
index.js Code climate fixes, travis config, badge 2017-08-20 20:21:44 -05:00
index.test.js Test to prove sorting by integer works 2017-08-17 18:17:06 -05:00
package.json Coverage 2018-02-22 18:44:27 -06:00
README.md Coverage 2018-02-22 18:44:27 -06:00
testdata.json Test to prove sorting by integer works 2017-08-17 18:17:06 -05:00

README.md

json-query-chain

Build Status npm version Code Climate Code Coverage

Chain queries onto POJOs to return precise results.

Usage

import Query from 'json-query-chain';

let myQ = new Query(someJsonData)
.search('isActiveUser', true)
.results;

Chainable Methods

Search

Currently supports booleans and strings. (See #1 for Integer Support)

By Boolean
.search('isActiveUser', true)
By String
.search('name', 'steele')

Filter

Simpler version of search using a custom function in the chain.

.filter(a => a.age >= 21)
By Key
.filterBy('age', x => x >= 21)

Sort

By Boolean
.sort('isActiveUser', true)
By String
.sort('name')
By Number
.sort('netWorth')

Pagination

Page 1 with 5 results per page.

.paginate(1, 5)

Page 2 wtih default of 10 results per page.

.paginate(2)

Tests

npm test runs tests through Jest