# search-npm-registry

> Search packages/modules among the NPM registry.

Latest version **2.0.3** (published 2018-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install search-npm-registry
pnpm add search-npm-registry
yarn add search-npm-registry
bun add search-npm-registry
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2018-03-01 |
| First published | 2018-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | eveningkid |
| Maintainers | eveningkid |
| Keywords | npm, keyword, package, packages, module, modules, pkg, registry, find, search |

## Links

- npm: https://www.npmjs.com/package/search-npm-registry
- Repository: https://github.com/eveningkid/search-npm-registry
- Homepage: https://github.com/eveningkid/search-npm-registry#readme
- Issues: https://github.com/eveningkid/search-npm-registry/issues
- npm.io page: https://npm.io/package/search-npm-registry

## Dependencies (2)

- [got](https://npm.io/package/got.md) ^8.2.0
- [registry-url](https://npm.io/package/registry-url.md) ^3.1.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2018-03-01
- 2.0.2 — 2018-03-01
- 2.0.1 — 2018-03-01
- 2.0.0 — 2018-03-01
- 1.0.0 — 2018-03-01

## README

# search-npm-registry
Quickly query NPM registry.  

## How to use?
```js
const searchNpmRegistry = require('search-npm-registry');

(async () => {
  const results = await searchNpmRegistry()
    .text('react')
    .size(5)
    .search();

  // results = [{ name: 'react', description: '...', ... }, ...]
  console.log(results);
})();
```

## API
Calling `searchNpmRegisty` will return an instance of `SearchNpmRegistry`.
You then can chain all the required options before searching modules:  
- `.text(string)`
- `.size(integer)`, limit
- `.from(integer)`
- `.quality(float)`, `.popularity(float)`, `.maintenance(float)`

When you're all set, simply call `.search()`. You'll get a `Promise` object from it.  
[Need more information about search parameters?](https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search)  

## License
MIT @ eveningkid

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