pkg2related

Return package names related to a specified package name.

Usage

var pkg2related = require( '@stdlib/namespace/pkg2related' );

pkg2related( pkg )

Returns package names related to a specified package name.

var out = pkg2related( '@stdlib/math/base/special/sin' );
// returns [...]

If provided an unrecognized package name, the function returns null.

var out = pkg2related( 'unrecognized_pkg_beep_boop_bop_bip' );
// returns null

Notes

The function supports providing both internal and standalone package names.

var out = pkg2related( '@stdlib/math-base-special-sin' );
// returns [...]

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var aliases = require( '@stdlib/namespace/aliases' );
var alias2pkg = require( '@stdlib/namespace/alias2pkg' );
var pkg2related = require( '@stdlib/namespace/pkg2related' );

var list;
var len;
var idx;
var pkg;
var v;
var i;

list = aliases();
len = list.length;

for ( i = 0; i < 100; i++ ) {
    idx = discreteUniform( 0, len-1 );
    v = list[ idx ];
    pkg = alias2pkg( v );
    console.log( 'alias: %s. related: %s.', v, pkg2related( pkg ).join( ', ' ) );
}

CLI

Usage

Usage: stdlib-pkg2related [options] <pkg>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ stdlib-pkg2related '@stdlib/math/base/special/sin'

License

The data files (databases) are licensed under an Open Data Commons Public Domain Dedication & License 1.0 and their contents are licensed under Creative Commons Zero v1.0 Universal. The software is licensed under Apache License, Version 2.0.