0.0.3 • Published 5 years ago
package-meta-d v0.0.3
package-meta-d
Get metadata of a package from the npm registry
Install
$ npm install package-meta-d
Usage
const packageJson = require('package-meta-d');
(async () => {
console.log(await packageJson('angular'));
//=> {name: 'ava', ...}
// Also works with scoped packages
console.log(await packageJson('@angular/cli'));
})();
API
packageJson(name, options)
name
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 latest1.x.x
1.2
- Get the latest1.2.x
^1.2.3
- Get the latest1.x.x
but at least1.2.3
~1.2.3
- Get the latest1.2.x
but at least1.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.
packageJson.packageNotFound
The error thrown when the given package name cannot be found.
packageJson.packageVersionNotFound
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.