Search npm packages

Promise based package for searching other npm packages in registry. With rating search support as on the npmjs.com

Instalation

1npm i search-npm-packages
2# or if you using yarn
3yarn add search-npm-packages

Usage

1const npmSearch = require('search-npm-packages')

Or import using TypeScript or ESM

1import npmSearch from 'search-npm-packages'

Simple search by name

The output will be an array with packages from the register

1npmSearch({ name: 'telegram' })
2    .then(packages => console.log(packages))
3    .catch(e => console.error(e))
4
5// output:
6/*[
7    {
8      name: 'telegram',
9      scope: 'unscoped',
10      version: '1.0.0-alpha.2',
11      description: 'NodeJS MTProto API Telegram client library,',
12      date: { ts: 1575163205790, rel: '2 months ago' },
13      links: {
14        npm: 'https://www.npmjs.com/package/telegram',
15        homepage: 'https://github.com/gram-js/gramjs#readme',
16        repository: 'https://github.com/gram-js/gramjs',
17        bugs: 'https://github.com/gram-js/gramjs/issues'
18      },
19      publisher: {
20        name: 'youtwitface',
21        avatars: [Object],
22        created: [Object],
23        email: 'contact@lungers.com'
24      },
25      maintainers: [ [Object] ],
26      keywordsTruncated: false,
27      keywords: []
28    },
29    {
30      name: 'winston-telegram',
31      scope: 'unscoped',
32      version: '2.2.2',
33    ...
34*/

Search by keywords

For search by keywords use keywords option.

if use the name and keywords option at the same time. The search will be performed by keywords

1npmSearch({ keywords: ['backend', 'cli'] })
2    .then(packages => console.log(packages))
3    .catch(e => console.error(e))
4
5// output:
6/*[
7    {
8        name: '@rucken/cli',
9        scope: 'rucken',
10        version: '4.1.5',
11        description: 'Console tools for create and build Angular7+, Bootstrap, Ionic and NestJS application based on Rucken template',
12        keywords: [
13          'cli',       'nx',
14         'workspace', 'ngx',
15         'angular7',  'nestjs',
16          'ionic',     'bootstrap',
17          'rucken',    'admin',
18         'ui',        'backend',
19         'mobile',    'frontend'
20        ],
21        date: { ts: 1557580280060, rel: '9 months ago' },
22
23        ...
24*/

Ranking search

You can use ranking search as on the npmjs.com

ranking can be optimal, popularity, quality or maintenance.

1npmSearch({
2    name: 'torrent',
3    ranking: "quality"
4})
5    .then(packages => packages.forEach(p => {
6        console.log(p.links.npm)
7    }))
8
9// output:
10/*
11https://www.npmjs.com/package/torrent
12https://www.npmjs.com/package/torrent-extract-hash
13https://www.npmjs.com/package/magnet2torrent
14...
15*/

TypeScript

This package with full TypeScript support. And your IDE can use autocomplete.

Also you can import RegistryPackage type, and NpmSearchParams

1import { RegistryPackage, NpmSearchParams } from "search-npm-packages";