0.1.0 • Published 5 years ago

npm-package-info v0.1.0

Weekly downloads
12
License
ISC
Repository
github
Last release
5 years ago

npm-package

fetches the package information for an npm package

Usage

npm install --save npm-package-info

or

npm install -g npm-package-info

node module

var npmPackage = require('npm-package-info')

// get a public package
npmPackage('package-name', function(err, pkg) {
  // pkg is an object containing the contents of package.json
})

// get a private github package
npmPackage('user/repo', { token: 'githubtoken' }, function(err, pkg) {
  // same as above
})

command line

# public
$ npm-package package-name
# private
$ npm-package --token githubtoken package-name
# both above commands output pretty printed json to stdout

# disable pretty-printing (print json all on one line)
$ npm-package --raw package-name

generating a github token

The tokens used above are for accessing private github content via the API. You can find out how to generate a github token here:

https://help.github.com/articles/creating-an-access-token-for-command-line-use/

FAQ

  • Does this work with private npm hosts?

I dunno, but probably. I don't currently use private npm packages or self hosted npm, so testing and reporting issues in this area would be appreciated!

  • Does this work with ?

Probably! This uses the same resolver as npm core, so in theory it should be able to resolve anything npm can resolve, including version numbers and tags. That being said, if you find something that doesn't work, please file an issue so I can fix it.