Skip to content

Files

Latest commit

02a3539 · Mar 22, 2023

History

History

code-blocks

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Mar 22, 2019
Jun 29, 2021
Mar 22, 2023
Mar 22, 2019
Mar 22, 2019
Mar 22, 2019
Sep 15, 2022
Apr 15, 2019
Dec 20, 2020
Mar 22, 2019
Sep 5, 2021
Mar 22, 2019
Aug 21, 2021

Examples

Return an example associated with a provided alias.

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

CLI

Usage

Usage: stdlib-alias-example [options] <alias>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ stdlib-alias-example '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.