# string-hunt

> Full Text Search Algorithm

Latest version **1.1.0** (published 2023-10-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install string-hunt
pnpm add string-hunt
yarn add string-hunt
bun add string-hunt
```

## 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.0 |
| Published | 2023-10-08 |
| First published | 2023-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Murangwa Pacifique && Ndizihiwe Regis |
| Maintainers | ndzhwr |
| Keywords | searching, json-search, fast search |

## Links

- npm: https://www.npmjs.com/package/string-hunt
- Repository: https://github.com/regisrex/string-hunt
- Homepage: https://github.com/regisrex/string-hunt#readme
- Issues: https://github.com/regisrex/string-hunt/issues
- npm.io page: https://npm.io/package/string-hunt

## Dependencies (1)

- [valdie](https://npm.io/package/valdie.md) ^0.1.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-10-08
- 1.0.0 — 2023-10-08
- 0.0.3 — 2023-09-30
- 0.0.2 — 2023-09-30
- 0.0.1 — 2023-09-30

## README

# Full Text Search Algorithm
___

Text search algorithm for searching through a list of JSON objects

```bash
$  yarn add string-hunt
```

## Usage
```Javascript
const search  = require('string-hunt')

const data = [
    {
        name : "Cedrick",
        age : 20
    },
    {
        name : "Marrick",
        age :  10
    }
]

(() => {
    const results = search(data.map(datum => JSON.stringify(datum)), 'rick0')
    console.log(results.length)    // 2
})()

```
## Contributing
Contributors are welcomed, you can contribute by  opening an issue or making a pull request (which is better 😀).

## Maintainers 
It is maintained by [@pacifiquem](https://github.com/pacifiquem) and [@regisrex](https://github.com/regisrex)

## Licence 
This project is under [MIT Licence](./LICENCE)

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