Package Exports

@stdlib/utils-function-name

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-function-name) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Function Name

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

For more information regarding the naming of anonymous functions, see
- Function Names in ES6
- Webkit bug 7726
- MDN

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'

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.

License

See LICENSE.

@stdlib/utils-function-name