58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
# package-json [](https://travis-ci.org/sindresorhus/package-json)
|
|
|
|
> Get the package.json of a package from the npm registry
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save package-json
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var packageJson = require('package-json');
|
|
|
|
packageJson('pageres', 'latest', function (err, json) {
|
|
console.log(json);
|
|
//=> { name: 'pageres', ... }
|
|
});
|
|
|
|
// also works with scoped packages
|
|
packageJson('@company/package', 'latest', function (err, json) {
|
|
console.log(json);
|
|
//=> { name: 'package', ... }
|
|
});
|
|
|
|
packageJson.field('pageres', 'description', function (err, field) {
|
|
console.log(field);
|
|
//=> 'Capture website screenshots'
|
|
});
|
|
```
|
|
|
|
|
|
## API
|
|
|
|
### packageJson(name, [version], callback)
|
|
|
|
You can optionally specify a version (e.g. `0.1.0`) or `latest`.
|
|
If you don't specify a version you'll get the [main entry](http://registry.npmjs.org/pageres/) containing all versions.
|
|
|
|
### packageJson.field(name, field, callback)
|
|
|
|
Get a specific field in the `package.json`.
|
|
|
|
|
|
## Related
|
|
|
|
- [npm-keyword](https://github.com/sindresorhus/npm-keyword) - Get a list of npm packages with a certain keyword
|
|
- [npm-user](https://github.com/sindresorhus/npm-user) - Get user info of a npm user
|
|
- [npm-email](https://github.com/sindresorhus/npm-email) - Get the email of a npm user
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Sindre Sorhus](http://sindresorhus.com)
|