# searchx

> A tiny library to perform search on JavaScript objects

Latest version **1.1.1** (published 2019-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install searchx
pnpm add searchx
yarn add searchx
bun add searchx
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-01-07 |
| First published | 2019-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 172.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Wahaj Aayani |
| Maintainers | aayani |
| Keywords | search, searchx, modules, util |

## Links

- npm: https://www.npmjs.com/package/searchx
- Repository: https://github.com/aayani/searchX
- Homepage: https://github.com/aayani/searchX#readme
- Issues: https://github.com/aayani/searchX/issues
- npm.io page: https://npm.io/package/searchx

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2019-01-07
- 1.1.0 — 2019-01-06
- 1.0.4 — 2019-01-06
- 1.0.3 — 2019-01-06
- 1.0.2 — 2019-01-06
- 1.0.1 — 2019-01-06
- 1.0.0 — 2019-01-06

## README

# searchX v1.1.0
[![npm package](https://badge.fury.io/js/searchx.svg)](https://www.npmjs.com/package/searchx) [![build](https://travis-ci.org/aayani/searchX.svg?branch=master)](https://travis-ci.org/aayani/searchX) [![coverage](https://coveralls.io/repos/github/aayani/searchX/badge.svg?branch=master)](https://coveralls.io/github/aayani/searchX?branch=master) [![dependencies](https://david-dm.org/aayani/searchx.svg)](https://david-dm.org/aayani/searchx) [![devDependencies](https://david-dm.org/aayani/searchx/dev-status.svg)](https://david-dm.org/aayani/searchx?type=dev)  
 A tiny library to perform search on JavaScript objects.
## Installation
```sh
$ npm install searchx --save
$ yarn add searchx
```
## Usage
```js
// 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
```sh
$ 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](LICENSE) file for details

---
_Source: https://npm.io/package/searchx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._