time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

function_name.js (1759B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var isFunction = require( '@stdlib/assert/is-function' );
     24 var hasFunctionNameSupport = require( '@stdlib/assert/has-function-name-support' );
     25 var RE = require( '@stdlib/regexp/function-name' ).REGEXP;
     26 
     27 
     28 // VARIABLES //
     29 
     30 var isFunctionNameSupported = hasFunctionNameSupport();
     31 
     32 
     33 // MAIN //
     34 
     35 /**
     36 * Returns the name of a function.
     37 *
     38 * @param {Function} fcn - input function
     39 * @throws {TypeError} must provide a function
     40 * @returns {string} function name
     41 *
     42 * @example
     43 * var v = functionName( Math.sqrt );
     44 * // returns 'sqrt'
     45 *
     46 * @example
     47 * var v = functionName( function foo(){} );
     48 * // returns 'foo'
     49 *
     50 * @example
     51 * var v = functionName( function(){} );
     52 * // returns '' || 'anonymous'
     53 *
     54 * @example
     55 * var v = functionName( String );
     56 * // returns 'String'
     57 */
     58 function functionName( fcn ) {
     59 	// TODO: add support for generator functions?
     60 	if ( isFunction( fcn ) === false ) {
     61 		throw new TypeError( 'invalid argument. Must provide a function. Value: `' + fcn + '`.' );
     62 	}
     63 	if ( isFunctionNameSupported ) {
     64 		return fcn.name;
     65 	}
     66 	return RE.exec( fcn.toString() )[ 1 ];
     67 }
     68 
     69 
     70 // EXPORTS //
     71 
     72 module.exports = functionName;