Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

package-json

6.2.0 • Public • Published

package-json Build Status

Get metadata of a package from the npm registry

Install

$ npm install package-json

Usage

const packageJson = require('package-json');
 
(async () => {
    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: http.Agent | https.Agent | Object | false

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

packageJson.PackageNotFoundError

The error thrown when the given package name cannot be found.

packageJson.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.

Related

License

MIT © Sindre Sorhus

install

npm i package-json

Downloadsweekly downloads

3,300,653

version

6.2.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability