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.x1.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, or see the type definitions.
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.
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 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, which this package uses internally.
Support for this may come to Node.js in the future.
Related
