Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/repl-signature

Return the signature(s) associated with a provided alias.
https://github.com/stdlib-js/repl-signature

api docs documentation help interface javascript man manual node node-js nodejs repl signature stdlib

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README 

        



  

    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!



# Signature



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



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



## Installation



```bash

npm install @stdlib/repl-signature

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

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

```



#### signature( alias )



Returns the signature(s) for a provided alias.



```javascript

var out = signature( 'base.sin' );

// returns [ '...' ]

```



If provided an unrecognized `alias`, the function returns `null`.



```javascript

var txt = signature( 'unrecognized_alias_beep_boop_bop_bip' );

// returns null

```



## Examples



```javascript

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

    }

}

```



* * *



## CLI



## Installation



To use as a general utility, install the CLI package globally



```bash

npm install -g @stdlib/repl-signature-cli

```



### Usage



```text

Usage: stdlib-alias-signature [options] 



Options:



  -h,    --help                Print this message.

  -V,    --version             Print the package version.

```



### Examples



```bash

$ stdlib-alias-signature 'base.sin'

```



## License



The data files (databases) are licensed under an [Open Data Commons Public Domain Dedication & License 1.0][pddl-1.0] and their contents are licensed under [Creative Commons Zero v1.0 Universal][cc0]. The software is licensed under [Apache License, Version 2.0][apache-license].



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/repl-signature.svg

[npm-url]: https://npmjs.org/package/@stdlib/repl-signature



[test-image]: https://github.com/stdlib-js/repl-signature/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/repl-signature/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/repl-signature/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/repl-signature?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[cli-section]: https://github.com/stdlib-js/repl-signature#cli

[cli-url]: https://github.com/stdlib-js/repl-signature/tree/cli

[@stdlib/repl-signature]: https://github.com/stdlib-js/repl-signature/tree/main



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/repl-signature/tree/deno

[deno-readme]: https://github.com/stdlib-js/repl-signature/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/repl-signature/tree/umd

[umd-readme]: https://github.com/stdlib-js/repl-signature/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/repl-signature/tree/esm

[esm-readme]: https://github.com/stdlib-js/repl-signature/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/repl-signature/blob/main/branches.md



[pddl-1.0]: http://opendatacommons.org/licenses/pddl/1.0/



[cc0]: https://creativecommons.org/publicdomain/zero/1.0



[apache-license]: https://www.apache.org/licenses/LICENSE-2.0