Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/package-json
Get metadata of a package from the npm registry
https://github.com/sindresorhus/package-json
Last synced: about 1 month ago
JSON representation
Get metadata of a package from the npm registry
- Host: GitHub
- URL: https://github.com/sindresorhus/package-json
- Owner: sindresorhus
- License: mit
- Created: 2014-06-15T17:35:30.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T04:05:47.000Z (8 months ago)
- Last Synced: 2024-04-14T04:18:49.468Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 230
- Watchers: 9
- Forks: 61
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-npm - package-json - Get the package.json of a package from the npm registry. (Packages / Registry)
- awesome-npm - package-json - Get the package.json of a package from the npm registry. (Packages / Registry)
README
# package-json
> Get metadata of a package from the npm registry
## Install
```sh
npm install package-json
```
## Usage
```js
import packageJson from 'package-json';
console.log(await packageJson('ava'));
//=> {name: 'ava', …}
// Also works with scoped packages
console.log(await packageJson('@sindresorhus/df'));
```
## API
### packageJson(packageName, options?)
#### packageName
Type: `string`
Name of the package.
#### options
Type: `object`
##### version
Type: `string`\
Default: `latest`
Package version such as `1.0.0` or a [dist tag](https://docs.npmjs.com/cli/dist-tag) such as `latest`.
The version can also be in any format supported by the [semver](https://github.com/npm/node-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`
##### fullMetadata
Type: `boolean`\
Default: `false`
By default, only an abbreviated metadata object is returned for performance reasons. [Read more](https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md), or see the [type definitions](index.d.ts).
##### allVersions
Type: `boolean`\
Default: `false`
Return the [main entry](https://registry.npmjs.org/ava) containing all versions.
##### registryUrl
Type: `string`\
Default: Auto-detected
The registry URL is by default inferred from the npm defaults and `.npmrc`. This is beneficial as `package-json` and any project using it will work just like npm. This option is **only** intended for internal tools. You should **not** use this option in reusable packages. Prefer just using `.npmrc` whenever possible.
##### omitDeprecated
Type: `boolean`\
Default: `true`
Whether or not to omit deprecated versions of a package.
If set, versions marked as deprecated on the registry are omitted from results. Providing a dist tag or a specific version will still return that version, even if it's deprecated. If no version can be found once deprecated versions are omitted, a [`VersionNotFoundError`](#versionnotfounderror) is thrown.
### PackageNotFoundError
The error thrown when the given package name cannot be found.
### VersionNotFoundError
The error thrown when the given package version cannot be found.
## 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.
## Proxies
Proxy support is not implemented in this package. If necessary, use a global agent that modifies [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), which this package uses internally.
Support for this may come to [Node.js in the future](https://github.com/nodejs/undici/issues/1650).
## 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