History

rui hildt 4f5db9ab26 Add initial version of dijkstra backend cloudron image		2020-10-12 11:27:15 +02:00
..
index.js	Add initial version of dijkstra backend cloudron image	2020-10-12 11:27:15 +02:00
license	Add initial version of dijkstra backend cloudron image	2020-10-12 11:27:15 +02:00
package.json	Add initial version of dijkstra backend cloudron image	2020-10-12 11:27:15 +02:00
readme.md	Add initial version of dijkstra backend cloudron image	2020-10-12 11:27:15 +02:00

readme.md

package-json

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:

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