Signature

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

Installation

npm install @stdlib/repl-signature

Usage

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

signature( alias )

Returns the signature(s) for a provided alias.

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

If provided an unrecognized alias, the function returns null.

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

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var aliases = require( '@stdlib/namespace-aliases' );
var signature = require( '@stdlib/repl-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 = signature( list[ idx ] );
    if ( sig ) {
        console.log( sig.join( '\n' ) );
    }
}

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-signature-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.