Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.27 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.27 KB

This is no longer needed, try

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.