@stdlib/repl-code-blocks
v0.4.0
Published
Return an example associated with a provided alias.
Downloads
60
Readme
Examples
Return an example associated with a provided alias.
Installation
npm install @stdlib/repl-code-blocks
Usage
var example = require( '@stdlib/repl-code-blocks' );
example( alias )
Returns an example associated with a provided alias.
var out = example( 'base.sin' );
// returns <string>
If provided an unrecognized alias
, the function returns null
.
var out = example( 'unrecognized_alias_beep_boop_bop_bip' );
// returns null
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var aliases = require( '@stdlib/namespace-aliases' );
var example = require( '@stdlib/repl-code-blocks' );
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( example( 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-code-blocks-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.