Get the package.json of a package from the npm registry
JavaScript
Latest commit 11dcc82 Feb 18, 2017 @sindresorhus 3.1.0

readme.md

package-json Build Status

Get the package.json of a package from the npm registry

Install

$ npm install --save package-json

Usage

const packageJson = require('package-json');

packageJson('pageres', 'latest').then(json => {
    console.log(json);
    //=> {name: 'pageres', ...}
});

// Also works with scoped packages
packageJson('@company/package', 'latest').then(json => {
    console.log(json);
    //=> {name: 'package', ...}
});

API

packageJson(name, [version])

You can optionally specify a version (e.g. 1.0.0) or a dist tag such as latest. If you don't specify a version you'll get the main entry containing all versions.

The version can also be in any format supported by the semver module. For example:

  • 1 - get the latest 1.x.x
  • 1.2 - get the latest 1.2.x
  • ^1.2.3 - get the latest 1.x.x but at least 1.2.3
  • ~1.2.3 - get the latest 1.2.x but at least 1.2.3

Authentication

Both public and private registries are supported, for both scoped and unscoped packages, as long as the registry uses either bearer tokens or basic authentication.

Related

License

MIT © Sindre Sorhus