# package-json

> Get metadata of a package from the npm registry

Latest version **10.0.1** (published 2024-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install package-json
pnpm add package-json
yarn add package-json
bun add package-json
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 10.0.1 |
| Published | 2024-07-14 |
| First published | 2014-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 4 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 251 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | npm, registry, package, pkg, package.json, json, module, scope, scoped |

## Links

- npm: https://www.npmjs.com/package/package-json
- Repository: https://github.com/sindresorhus/package-json
- Homepage: https://github.com/sindresorhus/package-json#readme
- Issues: https://github.com/sindresorhus/package-json/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/package-json

## Dependencies (4)

- [ky](https://npm.io/package/ky.md) ^1.2.0
- [semver](https://npm.io/package/semver.md) ^7.6.0
- [registry-url](https://npm.io/package/registry-url.md) ^6.0.1
- [registry-auth-token](https://npm.io/package/registry-auth-token.md) ^5.0.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 10.0.1 (latest) — 2024-07-14
- 10.0.0 — 2024-02-25
- 9.0.0 — 2024-01-23
- 8.1.1 — 2023-06-14
- 8.1.0 — 2022-06-19
- 8.0.0 — 2022-06-06
- 7.0.0 — 2021-06-24
- 6.5.0 — 2019-07-23
- 6.4.0 — 2019-06-11
- 6.3.0 — 2019-03-31
- 6.2.0 — 2019-03-23
- 6.1.0 — 2019-03-12
- 6.0.0 — 2019-01-29
- 5.0.0 — 2018-05-17
- 4.0.1 — 2017-04-17
- … 20 more at https://npm.io/package/package-json/versions

## 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

---
_Source: https://npm.io/package/package-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._