searchX v1.1.0

A tiny library to perform search on JavaScript objects.

Installation

$ npm install searchx --save
$ yarn add searchx

Usage

// Load the build.
var { search } = require('searchx');
// keyword: string - "A keyword to look for in a collection"
// collection: Array<object> - "An array of objects to perform search on"
// options = {
//   columns: ['col1', 'col2', 'col3'], // attributes to perform search on. (null by default)
// };
// This will return a promise.
var promise = search(keyword, collection, options);
// Resolving the promise would return the search results.
return promise.then(result => result);

Test

$ npm run test
$ yarn test

Support

Tested in Chrome, Firefox, Edge & IE.

License

This project is licensed under the MIT License - see the LICENSE.md file for details