Typed Signature

Return the typed signature(s) associated with a provided alias.

Usage

var typedSignature = require( '@stdlib/repl/typed-signature' );

typedSignature( alias )

Returns the typed signature(s) for a provided alias.

var out = typedSignature( 'base.sin' );
// returns [ '...' ]

If provided an unrecognized alias, the function returns null.

var txt = typedSignature( 'unrecognized_alias_beep_boop_bop_bip' );
// returns null

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var aliases = require( '@stdlib/namespace/aliases' );
var typedSignature = require( '@stdlib/repl/typed-signature' );

var list;
var len;
var idx;
var sig;
var i;

list = aliases();
len = list.length;

for ( i = 0; i < 100; i++ ) {
    idx = discreteUniform( 0, len-1 );
    sig = typedSignature( list[ idx ] );
    if ( sig ) {
        console.log( sig.join( '\n' ) );
    }
}

CLI

Usage

Usage: stdlib-alias-typed-signature [options] <alias>

Options:

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

Examples

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