Package Exports
- @stdlib/namespace-pkg2alias
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/namespace-pkg2alias) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
pkg2alias
Return the alias associated with a specified package name.
Installation
npm install @stdlib/namespace-pkg2aliasUsage
var pkg2alias = require( '@stdlib/namespace-pkg2alias' );pkg2alias( pkg )
Returns the alias associated with a specified package name.
var v = pkg2alias( '@stdlib/math-base-special-sin' );
// returns 'base.sin'If provided an unrecognized pkg, the function returns null.
var v = pkg2alias( 'unrecognized_pkg_beep_boop_bop_bip' );
// returns nullNotes
The function supports providing both internal and standalone package names.
var v = pkg2alias( '@stdlib/math-base-special-sin' ); // returns 'base.sin'
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var aliases = require( '@stdlib/namespace-aliases' );
var alias2pkg = require( '@stdlib/namespace-alias2pkg' );
var pkg2alias = require( '@stdlib/namespace-pkg2alias' );
var list;
var len;
var idx;
var v1;
var v2;
var i;
list = aliases();
len = list.length;
// Round-trip from alias-to-pkg-to-alias...
for ( i = 0; i < 100; i++ ) {
idx = discreteUniform( 0, len-1 );
v1 = alias2pkg( list[ idx ] );
v2 = pkg2alias( v1 );
console.log( 'alias: %s. pkg: %s.', list[ idx ], v1 );
console.log( 'pkg: %s. alias: %s.', v1, v2 );
}CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/namespace-pkg2aliasUsage
Usage: stdlib-pkg2alias [options] namespace-pkg2alias
Options:
-h, --help Print this message.
-V, --version Print the package version.Examples
$ stdlib-pkg2alias '@stdlib/math-base-special-sin'
base.sinLicense
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.
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-2021. The Stdlib Authors.