blob: 4fe7d7af8935dafc081131095447db1836ab7db3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# 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
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](https://docs.npmjs.com/cli/dist-tag) such as `latest`. If you don't specify a version you'll get the [main entry](http://registry.npmjs.org/pageres/) containing all versions.
The version can also be in any format supported by the [semver](https://www.npmjs.com/package/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
- [package-json-cli](https://github.com/sindresorhus/package-json-cli) - CLI for this module
- [latest-version](https://github.com/sindresorhus/latest-version) - Get the latest version of an npm package
- [pkg-versions](https://github.com/sindresorhus/pkg-versions) - Get the version numbers of a package from the npm registry
- [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 an npm user
- [npm-email](https://github.com/sindresorhus/npm-email) - Get the email of an npm user
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
