@stdlib/repl-typed-signature

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!

Typed Signature

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

Installation

npm install @stdlib/repl-typed-signature

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

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