Package Info

Get package information for one or more packages.

Installation

1$ npm install npm-registry-package-info

Usage

1var pkginfo = require( 'npm-registry-package-info' );

pkginfo( opts, clbk )

Get package information for one or more packages.

1var opts = {
2	'packages': [
3		'dstructs-matrix',
4		'compute-erf',
5		'utils-copy',
6		'unknown_package_name'
7	]	
8};
9
10pkginfo( opts, clbk );
11
12function clbk( error, data ) {
13	if ( error ) {
14		throw error;
15	}
16	console.dir( data );
17	/*
18		{
19			"meta": {
20				"total": 4,
21				"success": 3,
22				"failure": 1
23			},
24			"data": {
25				"dstructs-matrix": {...},
26				"compute-erf": {...},
27				"utils-copy": {...}
28			},
29			"failures": {
30				"unknown_package_name": "Not Found"
31			}
32		}
33	*/
34}

The function accepts the following options:

• packages: array of package names (required).
• registry: registry. Default: 'registry.npmjs.org'.
• port: registry port. Default: 443 (HTTPS) or 80 (HTTP).
• protocol: registry protocol. Default: 'https'.
• latest: boolean indicating whether to return only the latest package information from a registry.

To query an alternative registry, set the relevant options.

1var opts = {
2	'packages': [
3		'dstructs-array',
4		'flow-map',
5		'utils-merge2'
6	],
7	'registry': 'my.favorite.npm/registry',
8	'port': 80,
9	'latest': true,
10	'protocol': 'http'
11};
12
13pkginfo( opts, clbk );

pkginfo.factory( opts, clbk )

Creates a reusable function.

1var pkgs = [
2	'dstructs-matrix',
3	'compute-stdev',
4	'compute-variance'
5];
6
7var get = pkginfo.factory( {'packages': pkgs}, clbk );
8
9get();
10get();
11get();
12// ...

The factory method accepts the same options as pkginfo().

Notes

• If the module encounters an application-level error (e.g., no network connection, non-existent registry, etc), that error is returned immediately to the provided callback.
• If the module encounters a downstream error (e.g., timeout, reset connection, etc), that error is included in the returned results under the failures field.

Examples

1var ls = require( 'npm-list-author-packages' );
2var pkginfo = require( 'npm-registry-package-info' );
3
4var opts = {
5	'username': 'kgryte'
6};
7
8ls( opts, onList );
9
10function onList( error, list ) {
11	var opts;
12	if ( error ) {
13		throw error;
14	}
15	if ( !list.length ) {
16		return;
17	}
18	opts = {
19		'packages': list
20	};
21	pkginfo( opts, onInfo );
22}
23
24function onInfo( error, data ) {
25	if ( error ) {
26		throw error;
27	}
28	console.dir( data );
29}

To run the example code from the top-level application directory,

1$ DEBUG=* node ./examples/index.js

---

CLI

Installation

To use the module as a general utility, install the module globally

1$ npm install -g npm-registry-package-info

Usage

1Usage: pkginfo [options] pkg1 pkg2 ...
2
3Options:
4
5  -h,  --help                Print this message.
6  -V,  --version             Print the package version.
7  -p,  --port port           Registry port. Default: 443 (HTTPS) or 80 (HTTP).
8       --registry registry   Registry. Default: 'registry.npmjs.org'.
9       --protocol protocol   Registry protocol. Default: 'https'.
10       --latest              Only return the latest package entry.

Notes

• If a package is successfully resolved, the package info is written to stdout.
• If a package cannot be resolved due to a downstream error (failure), the package (and its associated error) is written to sterr.
• Output order is not guaranteed to match input order.

Examples

1$ DEBUG=* pkginfo dstructs-matrix compute-erf utils-copy
2# => {...}

---

Tests

Unit

This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:

1$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

1$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

1$ make view-cov

Browser Support

This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

1$ make test-browsers

To view the tests in a local web browser,

1$ make view-browser-tests

---

License

MIT license.

Copyright

Copyright © 2016. Athan Reines.