npm-keywordsearch
v0.1.1
Published
Get name and description of NPM packages matching a keyword
Downloads
9
Readme
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
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.