Refactor as factory function

Author: Planeshifter

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-doctest/test/fixtures/invalid.js

@@ -290,7 +290,7 @@ test = {
 		'',
 		'var isFunction = require( \'@stdlib/assert/is-function\' );',
 		'var hasFunctionNameSupport = require( \'@stdlib/assert/has-function-name-support\' );',
-		'var RE = require( \'@stdlib/regexp/function-name\' );',
+		'var RE = require( \'@stdlib/regexp/function-name\' ).REGEXP;',
 		'',
 		'',
 		'// VARIABLES //',

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-doctest/test/fixtures/valid.js

@@ -382,7 +382,7 @@ test = {
 		'',
 		'var isFunction = require( \'@stdlib/assert/is-function\' );',
 		'var hasFunctionNameSupport = require( \'@stdlib/assert/has-function-name-support\' );',
-		'var RE = require( \'@stdlib/regexp/function-name\' );',
+		'var RE = require( \'@stdlib/regexp/function-name\' ).REGEXP;',
 		'',
 		'',
 		'// VARIABLES //',

lib/node_modules/@stdlib/namespace/lib/namespace/r.js

@@ -1053,16 +1053,6 @@ ns.push({
 	]
 });
 
-ns.push({
-	'alias': 'RE_FUNCTION_NAME',
-	'path': '@stdlib/regexp/function-name',
-	'value': require( '@stdlib/regexp/function-name' ),
-	'type': 'RegExp',
-	'related': [
-		'@stdlib/utils/function-name'
-	]
-});
-
 ns.push({
 	'alias': 'RE_NATIVE_FUNCTION',
 	'path': '@stdlib/regexp/native-function',
@@ -1286,6 +1276,16 @@ ns.push({
 	'related': []
 });
 
+ns.push({
+	'alias': 'reFunctionName',
+	'path': '@stdlib/regexp/function-name',
+	'value': require( '@stdlib/regexp/function-name' ),
+	'type': 'Function',
+	'related': [
+		'@stdlib/utils/function-name'
+	]
+});
+
 ns.push({
 	'alias': 'reim',
 	'path': '@stdlib/complex/reim',

lib/node_modules/@stdlib/regexp/function-name/README.md

@@ -27,22 +27,34 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var RE_FUNCTION_NAME = require( '@stdlib/regexp/function-name' );
+var reFunctionName = require( '@stdlib/regexp/function-name' );
 ```
 
-#### RE_FUNCTION_NAME
+#### reFunctionName
 
-[Regular expression][regexp] to capture a `function` name.
+Returns a [regular expression][regexp] to capture a `function` name.
 
 ```javascript
 function beep() {
     return 'boop';
 }
 
+var RE_FUNCTION_NAME = reFunctionName();
 var str = RE_FUNCTION_NAME.exec( beep.toString() )[ 1 ];
 // returns 'beep'
 ```
 
+#### reFunctionName.REGEXP
+
+[Regular expression][regexp] to capture a `function` name.
+
+<!-- eslint-disable stdlib/no-builtin-math -->
+
+```javascript
+var str = reFunctionName.REGEXP.exec( Math.sqrt.toString() )[ 1 ];
+// returns 'sqrt'
+```
+
 </section>
 
 <!-- /.usage -->
@@ -57,7 +69,8 @@ var str = RE_FUNCTION_NAME.exec( beep.toString() )[ 1 ];
 
 ```javascript
 var Int8Array = require( '@stdlib/array/int8' );
-var RE_FUNCTION_NAME = require( '@stdlib/regexp/function-name' );
+var reFunctionName = require( '@stdlib/regexp/function-name' );
+var RE_FUNCTION_NAME = reFunctionName();
 
 function fname( fcn ) {
     return RE_FUNCTION_NAME.exec( fcn.toString() )[ 1 ];

lib/node_modules/@stdlib/regexp/function-name/benchmark/benchmark.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 var fromCodePoint = require( '@stdlib/string/from-code-point' );
 var pkg = require( './../package.json' ).name;
-var RE_FUNCTION_NAME = require( './../lib' );
+var reFunctionName = require( './../lib' );
 
 
 // MAIN //
@@ -37,7 +37,7 @@ bench( pkg, function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		str = 'function be'+fromCodePoint( 97 + (i%26) )+'ep () {}';
-		out = RE_FUNCTION_NAME.exec( str )[ 1 ];
+		out = reFunctionName.REGEXP.exec( str )[ 1 ];
 		if ( !isString( out ) ) {
 			b.fail( 'should return a string' );
 		}

lib/node_modules/@stdlib/regexp/function-name/docs/repl.txt

@@ -1,15 +1,30 @@
 
-{{alias}}
-    Regular expression to capture a function name.
+{{alias}}()
+    Return a regular expression to capture a function name.
+
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
 
     Examples
     --------
+    > var RE_FUNCTION_NAME = {{alias}}();
     > function beep() { return 'boop'; };
-    > var name = {{alias}}.exec( beep.toString() )[ 1 ]
+    > var name = RE_FUNCTION_NAME.exec( beep.toString() )[ 1 ]
     'beep'
-    > name = {{alias}}.exec( function () {} )[ 1 ]
+    > name = RE_FUNCTION_NAME.exec( function () {} )[ 1 ]
     ''
 
+
+{{alias}}.REGEXP
+    Regular expression to capture a function name.
+
+    Examples
+    --------
+    > var str = {{alias}}.REGEXP.exec( Math.sqrt.toString() )[ 1 ]
+    'sqrt'
+
     See Also
     --------
 

lib/node_modules/@stdlib/regexp/function-name/docs/types/index.d.ts

@@ -0,0 +1,74 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Interface for a regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
+*/
+interface ReFunctionName {
+	/**
+	* Returns a regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
+	*
+	* @returns regular expression
+	*
+	* @example
+	* var RE_FUNCTION_NAME = reFunctionName();
+	* function beep() {
+	*     return 'boop';
+	* }
+	*
+	* var str = RE_FUNCTION_NAME.exec( beep.toString() )[ 1 ];
+	* // returns 'beep'
+	*/
+	(): RegExp;
+
+	/**
+	* Regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
+	*
+	* @example
+	* var str = reFunctionName.REGEXP.exec( Math.sqrt.toString() )[ 1 ];
+	* // returns 'sqrt'
+	*/
+	REGEXP: RegExp;
+}
+
+/**
+* Returns a regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
+*
+* @returns regular expression
+*
+* @example
+* var RE_FUNCTION_NAME = reFunctionName();
+* function beep() {
+*     return 'boop';
+* }
+*
+* var str = RE_FUNCTION_NAME.exec( beep.toString() )[ 1 ];
+* // returns 'beep'
+*
+* @example
+* var str = reFunctionName.REGEXP.exec( Math.sqrt.toString() )[ 1 ];
+* // returns 'sqrt'
+*/
+declare var reFunctionName: ReFunctionName;
+
+
+// EXPORTS //
+
+export = reFunctionName;

lib/node_modules/@stdlib/regexp/function-name/docs/types/test.ts

@@ -0,0 +1,39 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import reFunctionName = require( './index' );
+
+
+// TESTS //
+
+// The function returns a regular expression...
+{
+	reFunctionName(); // $ExpectType RegExp
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	reFunctionName( 1 ); // $ExpectError
+	reFunctionName( 1, 2 ); // $ExpectError
+}
+
+// Attached to main export is a `REGEXP` property that is a regular expression...
+{
+	// tslint:disable-next-line:no-unused-expression
+	reFunctionName.REGEXP; // $ExpectType RegExp
+}

lib/node_modules/@stdlib/regexp/function-name/examples/index.js

@@ -21,7 +21,8 @@
 'use strict';
 
 var Int8Array = require( '@stdlib/array/int8' );
-var RE_FUNCTION_NAME = require( './../lib' );
+var reFunctionName = require( './../lib' );
+var RE_FUNCTION_NAME = reFunctionName();
 
 function fname( fcn ) {
 	return RE_FUNCTION_NAME.exec( fcn.toString() )[ 1 ];

lib/node_modules/@stdlib/regexp/function-name/lib/index.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2021 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -22,10 +22,10 @@
 * Regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
 *
 * @module @stdlib/regexp/function-name
-* @type {RegExp}
 *
 * @example
-* var RE_FUNCTION_NAME = require( '@stdlib/regexp/function-name' );
+* var reFunctionName = require( '@stdlib/regexp/function-name' );
+* var RE_FUNCTION_NAME = reFunctionName();
 *
 * function fname( fcn ) {
 *     return RE_FUNCTION_NAME.exec( fcn.toString() )[ 1 ];
@@ -44,39 +44,18 @@
 * // returns ''
 */
 
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
+var reFunctionName = require( './main.js' );
+var REGEXP = require( './regexp.js' );
+
 
 // MAIN //
 
-/**
-* Captures everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
-*
-* Regular expression: `/^\s*function\s*([^(]*)/i`
-*
-* -   `/^\s*`
-*     -   Match zero or more spaces at beginning
-*
-* -   `function`
-*     -   Match the word `function`
-*
-* -   `\s*`
-*     -   Match zero or more spaces after the word `function`
-*
-* -   `()`
-*     -   Capture
-*
-* -   `[^(]*`
-*     -   Match anything except a left parenthesis `(` zero or more times
-*
-* -   `/i`
-*     -   ignore case
-*
-* @constant
-* @type {RegExp}
-* @default /^\s*function\s*([^(]*)/i
-*/
-var RE_FUNCTION_NAME = /^\s*function\s*([^(]*)/i;
+setReadOnly( reFunctionName, 'REGEXP', REGEXP );
 
 
 // EXPORTS //
 
-module.exports = RE_FUNCTION_NAME;
+module.exports = reFunctionName;