package-metadata
v1.1.2
Published
Retrieves package.json metadata from the configured registry
Downloads
30
Maintainers
Readme
Get metadata of a package from the configured npm registry
Install
$ npm install package-metadata
Usage
import { RegistryClient } from 'package-metadata';
RegistryClient.getMetadata('package-metadata')
.then((metadata) => {
console.log(metadata);
});
(async () => {
const metadata = await RegistryClient.getMetadata('@types/node');
console.log(metadata);
})();
RegistryClient API
getMetadata(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.
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.
License
MIT ©