README
Help
Return help text associated with a provided alias.
Installation
npm install @stdlib/repl-help
Usage
var help = require( '@stdlib/repl-help' );
help( alias )
Returns help text for a provided alias.
var txt = help( 'base.sin' );
// returns <string>
If provided an unrecognized alias
, the function returns null
.
var txt = help( 'unrecognized_alias_beep_boop_bop_bip' );
// returns null
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var aliases = require( '@stdlib/namespace-aliases' );
var help = require( '@stdlib/repl-help' );
var list;
var len;
var idx;
var i;
list = aliases();
len = list.length;
for ( i = 0; i < 100; i++ ) {
idx = discreteUniform( 0, len-1 );
console.log( help( list[ idx ] ) );
}
CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/repl-help
Usage
Usage: stdlib-alias-help [options] <alias>
Options:
-h, --help Print this message.
-V, --version Print the package version.
Examples
$ stdlib-alias-help 'base.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.
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.