@stdlib/repl-help

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!

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 ] ) );
}

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/repl-help-cli: CLI package for use as a command-line utility.

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.

Changelog

0.3.0 (2024-07-27)

<section class="features">

Features

• ba4ce18 - add amskput to namespace
• 3eb5c20 - add aplace to namespace
• 0f9acd1 - add BooleanArray to namespace
• d7798af - add isNonNegativeFinite to namespace
• 2370b7a - update REPL namespace (#1352)

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• cde60a1 - docs: update REPL namespace documentation (#2643) (by stdlib-bot, Athan Reines)
• 80f7ad3 - docs: update REPL namespace documentation (#2638) (by stdlib-bot, Philipp Burckhardt)
• c89a171 - docs: update REPL namespace documentation (#2629) (by stdlib-bot, Athan Reines)
• 203021c - docs: update REPL namespace documentation (#2622) (by stdlib-bot, Philipp Burckhardt)
• 60d2ac3 - docs: update REPL namespace documentation (#2608) (by stdlib-bot, Athan Reines)
• 1dc058b - docs: update REPL namespace documentation (#2594) (by stdlib-bot, Athan Reines)
• 6a106fb - docs: update REPL namespace documentation (#2592) (by stdlib-bot, Athan Reines)
• b184238 - docs: update REPL namespace documentation (#2583) (by stdlib-bot, Athan Reines)
• f35fdd1 - docs: update REPL namespace documentation (#2581) (by stdlib-bot, Athan Reines)
• 8751c3d - docs: update REPL namespace documentation (#2570) (by stdlib-bot, Athan Reines)
• 350aa53 - docs: update REPL namespace documentation (#2515) (by stdlib-bot, Athan Reines)
• fc67e61 - docs: update REPL namespace documentation (#2511) (by stdlib-bot, Athan Reines)
• 77ecc3a - docs: update REPL namespace documentation (#2501) (by stdlib-bot, Athan Reines)
• d2d46ed - docs: update REPL namespace documentation (#2492) (by stdlib-bot, Athan Reines)
• bdb7cab - docs: update REPL namespace documentation (#2491) (by stdlib-bot, Athan Reines)
• 581f17e - docs: update REPL namespace documentation (#2476) (by stdlib-bot, Athan Reines)
• cfb39e4 - docs: update REPL namespace documentation (#2475) (by stdlib-bot, Athan Reines)
• ebb5167 - docs: update REPL namespace documentation (#2467) (by stdlib-bot, Athan Reines)
• 882197a - docs: update REPL namespace documentation (#2466) (by stdlib-bot, Athan Reines)
• bfd5b70 - docs: update REPL namespace documentation (#2444) (by stdlib-bot, Athan Reines)
• 211c131 - docs: update REPL namespace documentation (#2437) (by stdlib-bot, Athan Reines)
• 6c876f7 - docs: update REPL namespace documentation (#2433) (by stdlib-bot, Athan Reines)
• a480f85 - docs: update REPL namespace documentation (#2427) (by stdlib-bot, Athan Reines)
• 1c27809 - docs: update REPL namespace documentation (#2426) (by stdlib-bot, Athan Reines)
• ba4ce18 - feat: add amskput to namespace (by Athan Reines)
• 3eb5c20 - feat: add aplace to namespace (by Athan Reines)
• 642d473 - docs: update REPL namespace documentation (#2416) (by stdlib-bot, Athan Reines)
• 379f259 - docs: update REPL namespace documentation (#2403) (by stdlib-bot, Athan Reines)
• e9f214c - docs: update REPL docs (by Athan Reines)
• e190a54 - docs: update REPL namespace documentation (#2395) (by stdlib-bot, Athan Reines)
• aae2b85 - docs: update REPL namespace documentation (#2386) (by stdlib-bot, Athan Reines)
• d74b255 - docs: update REPL namespace documentation (#2372) (by stdlib-bot, Athan Reines)
• f85ed2a - docs: update REPL namespace documentation (#2313) (by stdlib-bot, Athan Reines)
• f10aaf2 - docs: update REPL namespace documentation (#2311) (by stdlib-bot, Athan Reines)
• 34ef42e - docs: update REPL namespace documentation (#2246) (by stdlib-bot, Athan Reines)
• 0f9acd1 - feat: add BooleanArray to namespace (by Athan Reines)
• 732ffb9 - docs: update REPL namespace documentation (#2230) (by stdlib-bot, Philipp Burckhardt)
• b03225f - docs: update REPL namespace documentation (#2218) (by stdlib-bot, Philipp Burckhardt)
• bd40019 - docs: update REPL namespace documentation (#2212) (by stdlib-bot, Philipp Burckhardt)
• 657f3c3 - docs: update REPL namespace documentation (#2211) (by stdlib-bot, Philipp Burckhardt)
• f8fef42 - docs: update REPL namespace documentation (#2196) (by stdlib-bot, Philipp Burckhardt)
• cf35195 - docs: update REPL namespace documentation (#2191) (by stdlib-bot, Philipp Burckhardt)
• 3fff924 - docs: update REPL namespace documentation (#2179) (by stdlib-bot, Philipp Burckhardt)
• 6abb1f9 - docs: update REPL namespace documentation (#2168) (by stdlib-bot, Philipp Burckhardt)
• 7b77a10 - docs: update REPL namespace documentation (#2166) (by stdlib-bot, Philipp Burckhardt)
• 0920a48 - docs: update REPL namespace documentation (#2165) (by stdlib-bot, Philipp Burckhardt)
• dc6e8dd - docs: update REPL namespace documentation (#2164) (by stdlib-bot, Philipp Burckhardt)
• c91d15e - build: add trailing newlines in generated JSON files (by Philipp Burckhardt)
• 915a373 - docs: update REPL namespace documentation (#2158) (by stdlib-bot, Philipp Burckhardt)
• 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)
• d77bec4 - docs: update REPL namespace documentation (#2088) (by stdlib-bot, Philipp Burckhardt)
• 9211a99 - docs: update REPL namespace documentation (#2086) (by stdlib-bot, Philipp Burckhardt)
• faddc92 - docs: update REPL namespace documentation (#2052) (by stdlib-bot, Philipp Burckhardt)
• 7abac40 - docs: update REPL namespace documentation (#2045) (by stdlib-bot, Philipp Burckhardt)
• 6737428 - docs: update REPL namespace documentation (#2043) (by stdlib-bot)
• 719ac3e - docs: update REPL namespace documentation (#2033) (by stdlib-bot, Athan Reines)
• 3a06280 - docs: update REPL namespace documentation (#2023) (by stdlib-bot, Philipp Burckhardt)
• d761a25 - docs: update REPL namespace documentation (#2022) (by stdlib-bot, Philipp Burckhardt)
• f580092 - docs: update REPL namespace documentation (#2017) (by stdlib-bot, Athan Reines)
• cb2d15b - docs: update REPL namespace documentation (#2013) (by stdlib-bot, Philipp Burckhardt)
• 1259ab4 - docs: update REPL namespace documentation (#2004) (#2004) (by stdlib-bot, Philipp Burckhardt)
• 8a40170 - docs: update REPL namespace documentation (#2002) (by stdlib-bot, Athan Reines)
• 7715b47 - docs: update REPL namespace documentation (#1986) (by stdlib-bot, Athan Reines)
• 9aef63d - docs: update REPL namespace documentation (#1985) (by stdlib-bot, Athan Reines)
• 0541c04 - docs: update REPL namespace documentation (#1983) (by stdlib-bot, Philipp Burckhardt)
• fabfd65 - docs: update REPL namespace documentation (#1982) (by stdlib-bot, Philipp Burckhardt)
• 0b8a3d4 - docs: update REPL namespace documentation (#1979) (by stdlib-bot, Philipp Burckhardt)
• b9d0c57 - docs: update REPL namespace documentation (#1977) (by stdlib-bot, Athan Reines)
• 8dc9d13 - docs: update REPL namespace documentation (#1973) (by stdlib-bot, Athan Reines)
• 7945e17 - docs: update REPL namespace documentation (#1972) (by stdlib-bot, Athan Reines)
• c0993fa - docs: update REPL namespace documentation (#1956) (by stdlib-bot, kgryte)
• 7f3f555 - docs: update REPL namespace documentation (#1928) (by stdlib-bot, Planeshifter)
• d7798af - feat: add isNonNegativeFinite to namespace (by Athan Reines)
• b5f1824 - docs: update REPL namespace documentation (#1877) (by stdlib-bot, Philipp Burckhardt)
• e65e1fc - docs: update REPL namespace documentation (#1858) (by stdlib-bot, Athan Reines)
• fee1564 - docs: update REPL namespace documentation (#1817) (by stdlib-bot, Athan Reines)
• 13a8841 - docs: update REPL namespace documentation (#1708) (by stdlib-bot, Athan Reines)
• e330815 - docs: update REPL namespace documentation (#1699) (by stdlib-bot, Philipp Burckhardt)
• 103893f - docs: update REPL namespace documentation (#1688) (by stdlib-bot, Athan Reines)
• c44cae7 - docs: update REPL namespace documentation (#1677) (by stdlib-bot, Athan Reines)
• 2370b7a - feat: update REPL namespace (#1352) (by stdlib-bot, Athan Reines)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt
• kgryte

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">