@stdlib/utils-function-name
TypeScript icon, indicating that this package has built-in type declarations

0.0.8 • Public • Published

Function Name

NPM version Build Status Coverage Status

Determine a function's name.

Installation

npm install @stdlib/utils-function-name

Usage

var functionName = require( '@stdlib/utils-function-name' );

functionName( fcn )

Returns the name of a function.

var v = functionName( Math.sqrt );
// returns 'sqrt'

If provided an anonymous function, the function returns an empty string or the string "anonymous".

var v = functionName( function () {} );
// returns '' || 'anonymous'

If provided a value which is not a function, the function throws a TypeError.

try {
    functionName( 'beep' );
    // throws error...
} catch ( err ) {
    console.error( err );
}

Notes

Examples

var Float64Array = require( '@stdlib/array-float64' );
var Buffer = require( '@stdlib/buffer-ctor' );
var Number = require( '@stdlib/number-ctor' );
var functionName = require( '@stdlib/utils-function-name' );

var v = functionName( Math.sqrt );
// returns 'sqrt'

v = functionName( Float64Array );
// returns 'Float64Array'

v = functionName( Buffer );
// returns 'Buffer'

v = functionName( Date );
// returns 'Date'

v = functionName( String );
// returns 'String'

v = functionName( Boolean );
// returns 'Boolean'

v = functionName( Function );
// returns 'Function'

v = functionName( Number );
// returns 'Number'

v = functionName( function foo() {} );
// returns 'foo'

v = functionName( function () {} );
// returns '' || 'anonymous'

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.

Install

npm i @stdlib/utils-function-name

Homepage

stdlib.io

DownloadsWeekly Downloads

8,457

Version

0.0.8

License

Apache-2.0

Unpacked Size

38.1 kB

Total Files

9

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser