npm-keyword

Get a list of npm packages with a certain keyword

Install

$ npm install npm-keyword

Usage

const npmKeyword = require('npm-keyword');

(async () => {
	console.log(await npmKeyword('gulpplugin'));
	//=> [{name: 'gulp-autoprefixer', description: '…'}, …]

	console.log(await npmKeyword.names('gulpplugin'));
	//=> ['gulp-autoprefixer', …]

	console.log(await npmKeyword.count('gulpplugin'));
	//=> 3457
})();

Caveat

The list of packages will contain a maximum of 250 packages matching the keyword. This limitation is caused by the npm registry API.

API

npmKeyword(keyword, [options])

Returns a promise for a list of packages having the specified keyword in their package.json keyword property.

keyword

Type: string string[]
Example: ['string', 'camelcase']

One or more keywords. Only matches packages that have all the given keywords.

options

Type: Object

size

Type: number
Default: 250

Limits the amount of results.

npmKeyword.names(keyword, [options])

Returns a promise for a list of package names. Use this if you don't need the description as it's faster.

keyword

Type: string string[]
Example: ['string', 'camelcase']

One or more keywords. Only matches packages that have all the given keywords.

options

Type: Object

size

Type: number
Default: 250

Limits the amount of results.

npmKeyword.count(keyword)

Returns a promise for the count of packages.

keyword

Type: string string[]
Example: ['string', 'camelcase']

One or more keywords. Only matches packages that have all the given keywords.

package-json - Get the package.json of a package from the npm registry
npm-user - Get user info of an npm user
npm-email - Get the email of an npm user

License

Current Tags

6.1.0 ... latest (7 years ago)

npm-keyword

Install

Usage

Caveat

API

npmKeyword(keyword, [options])

keyword

options

size

npmKeyword.names(keyword, [options])

keyword

options

size

npmKeyword.count(keyword)

keyword

Related

License

Current Tags

14 Versions