@stdlib/namespace-pkg2related

pkg2related

Return package names related to a specified package name.

Installation

npm install @stdlib/namespace-pkg2related

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

Installation

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

npm install -g @stdlib/namespace-pkg2related

Usage

Usage: stdlib-pkg2related [options] namespace-pkg2related

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.

---

See Also

• @stdlib/namespace/alias2related: return aliases related to a specified alias.
• @stdlib/namespace/aliases: standard library aliases.
• @stdlib/namespace/pkg2alias: return the alias associated with a specified package name.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

Copyright

Copyright © 2016-2022. The Stdlib Authors.