@stdlib/namespace-pkg2alias
v0.3.0
Published
Return the alias associated with a specified package name.
Downloads
195
Readme
pkg2alias
Return the alias associated with a specified package name.
Installation
npm install @stdlib/namespace-pkg2alias
Usage
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 null
Notes
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 );
}
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-pkg2alias-cli
: CLI package for use as a command-line utility.@stdlib/namespace-alias2pkg
: return the package name associated with a specified alias.@stdlib/namespace-aliases
: standard library aliases.@stdlib/namespace-pkg2related
: return package names related to 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-2024. The Stdlib Authors.