"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x86/node_modules/npm/node_modules/package-json/readme.md" (14 Feb 2020, 2475 Bytes) of package /windows/www/node-v12.18.4-win-x86.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

package-json Build Status

Get metadata of a package from the npm registry

Install

$ npm install --save package-json

Usage

const packageJson = require('package-json');

packageJson('ava').then(json => {
    console.log(json);
    //=> {name: 'ava', ...}
});

// Also works with scoped packages
packageJson('@sindresorhus/df').then(json => {
    console.log(json);
    //=> {name: '@sindresorhus/df', ...}
});

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:

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 © Sindre Sorhus