Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

package-json

Package Overview
Dependencies
4
Maintainers
2
Versions
31
Issues
File Explorer

Advanced tools

package-json

Get metadata of a package from the npm registry

    8.1.0latest

Version published
Maintainers
2
Weekly downloads
7,993,648
decreased by-11.72%

Weekly downloads

Changelog

Source

  • Upgrade registry-auth-token to v5 (#67) 73515c2

https://github.com/sindresorhus/package-json/compare/v8.0.0...v8.1.0

Readme

Source

package-json

Get metadata of a package from the npm registry

Install

npm install package-json

Usage

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 such as latest.

The version can also be in any format supported by the 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.

allVersions

Type: boolean
Default: false

Return the main entry 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.

agent

Type: object

Overwrite the agent option that is passed down to got. This might be useful to add proxy support.

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.

package-json for enterprise

Available as part of the Tidelift Subscription.

The maintainers of package-json and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Keywords

FAQs

What is package-json?

Get metadata of a package from the npm registry

Is package-json popular?

The npm package package-json receives a total of 6,419,250 weekly downloads. As such, package-json popularity was classified as popular.

Is package-json well maintained?

We found that package-json demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 2 open source maintainers collaborating on the project.

Last updated on 19 Jun 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc