Get metadata of a package from the npm registry
$ npm install --save package-json
const packageJson = require('package-json');
packageJson('ava').then(json => {
console.log(json);
//=> {name: 'ava', ...}
});
// Also works with scoped packages
packageJson('@sindresorhus/df').then(json => {
console.log(json);
//=> {name: '@sindresorhus/df', ...}
});
Type: string
Name of the package.
Type: Object
Type: string
Default: latest
Package version such as 1.0.0
or a dist tag such as latest
.
The version can also be in any format supported by the semver module. For example:
1
- get the latest1.x.x
1.2
- get the latest1.2.x
^1.2.3
- get the latest1.x.x
but at least1.2.3
~1.2.3
- get the latest1.2.x
but at least1.2.3
Type: boolean
Default: false
By default, only an abbreviated metadata object is returned for performance reasons. Read more.
Type: boolean
Default: false
Return the main entry containing all versions.
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.
- package-json-cli - CLI for this module
- latest-version - Get the latest version of an npm package
- pkg-versions - Get the version numbers of a package from the npm registry
- npm-keyword - Get a list of npm packages with a certain keyword
- npm-user - Get user info of an npm user
- npm-email - Get the email of an npm user
MIT © Sindre Sorhus