❤
npm
Sign UpSign In

npm-keywordsearch

0.1.1 • Public • Published

Fetch list of packages on NPM with specified keyword

This queries the NPM registry with npm-registry-client It lists all packages matching a keyword using the CouchDB view byKeyword.

This is useful is you are writing a plugin system for instance, or an installer based of NPM.

Install

npm install --save npm-keywordsearch # yep 

Test npm test whatever-keyword

example screenshot

API

var search = require('npm-keywordsearch')
 
search('my-plugin', function (error, packages) {
  packages.forEach(function (pkg) {
    console.log(pkg.name + ': ' + pkg.description)
  })
})

You can also pass an alternative registry URL:

var opts = {
    // you must add the `byKeyword` view if it is not the default path
    registryURL: 'https://registry.npmjs.org/-/_view/byKeyword',
    keyword: 'my-plugin',
  debug: true
}
 
search(opts, function (error, packages) {
    packages.forEach(function (pkg) {
        console.log(pkg.name + ': ' + pkg.description)
    })
})

Based of http://stackoverflow.com/a/13657540/72787.

Readme

Keywords

Package Sidebar

Install

npm i npm-keywordsearch

Repository

github.com/wires/npm-keywordsearch

Homepage

github.com/wires/npm-keywordsearch#readme

Weekly Downloads

1

Version

0.1.1

License

AGPL-1.0

Last publish

Collaborators

  • wires
Try on RunKit
Report malware