About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Return help text associated with a provided alias.
npm install @stdlib/repl-helpAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README). - To use as a general utility for the command line, install the corresponding CLI package globally.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var help = require( '@stdlib/repl-help' );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 nullvar 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 ] ) );
}To use as a general utility, install the CLI package globally
npm install -g @stdlib/repl-help-cliUsage: stdlib-alias-help [options] <alias>
Options:
-h, --help Print this message.
-V, --version Print the package version.
$ stdlib-alias-help 'base.sin'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.
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.
Copyright © 2016-2024. The Stdlib Authors.
