Refactor as factory function

Author: Planeshifter

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

@@ -27,18 +27,28 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var RE_NATIVE_FUNCTION = require( '@stdlib/regexp/native-function' );
+var reNativeFunction = require( '@stdlib/regexp/native-function' );
 ```
 
-#### RE_NATIVE_FUNCTION
+#### reNativeFunction()
 
-[Regular expression][regexp] to match a native `function`.
+Returns a [regular expression][regexp] to match a native `function`.
 
 ```javascript
+var RE_NATIVE_FUNCTION = reNativeFunction();
 var bool = RE_NATIVE_FUNCTION.test( Date.toString() );
 // returns true
 ```
 
+#### reNativeFunction.REGEXP
+
+[Regular expression][regexp] to match a native `function`.
+
+```javascript
+var bool = reNativeFunction.REGEXP.test( Date.toString() );
+// returns true
+```
+
 </section>
 
 <!-- /.usage -->
@@ -53,8 +63,9 @@ var bool = RE_NATIVE_FUNCTION.test( Date.toString() );
 
 ```javascript
 var Int8Array = require( '@stdlib/array/int8' );
-var RE_NATIVE_FUNCTION = require( '@stdlib/regexp/native-function' );
+var reNativeFunction = require( '@stdlib/regexp/native-function' );
 
+var RE_NATIVE_FUNCTION = reNativeFunction();
 function isNativeFunction( fcn ) {
     return RE_NATIVE_FUNCTION.test( fcn.toString() );
 }

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

@@ -23,7 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
 var pkg = require( './../package.json' ).name;
-var RE_NATIVE_FUNCTION = require( './../lib' );
+var reNativeFunction = require( './../lib' );
 
 
 // VARIABLES //
@@ -53,7 +53,7 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		bool = RE_NATIVE_FUNCTION.test( values[ i%values.length ] );
+		bool = reNativeFunction.REGEXP.test( values[ i%values.length ] );
 		if ( !isBoolean( bool ) ) {
 			b.fail( 'should return a boolean' );
 		}

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

@@ -1,12 +1,29 @@
 
-{{alias}}
+{{alias}}()
+    Returns a regular expression to match a native function.
+
+    Returns
+    -------
+    re: RegExp
+        Regular expression.
+
+    Examples
+    --------
+    > var RE = {{alias}}();
+    > var bool = RE.test( Date.toString() )
+    true
+    > bool = RE.test( (function noop() {}).toString() )
+    false
+
+
+{{alias}}.REGEXP
     Regular expression to match a native function.
 
     Examples
     --------
-    > var bool = {{alias}}.test( Date.toString() )
+    > var bool = {{alias}}.REGEXP.test( Date.toString() )
     true
-    > bool = {{alias}}.test( (function noop() {}).toString() )
+    > bool = {{alias}}.REGEXP.test( (function noop() {}).toString() )
     false
 
     See Also

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

@@ -0,0 +1,66 @@
+/*
+* @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 match a native function.
+*/
+interface ReNativeFunction {
+	/**
+	* Returns a regular expression to match a native function.
+	*
+	* @returns regular expression
+	*
+	* @example
+	* var RE_NATIVE_FUNCTION = reNativeFunction();
+	* var bool = RE_NATIVE_FUNCTION.test( Date.toString() );
+	* // returns true
+	*/
+	(): RegExp;
+
+	/**
+	* Regular expression to match a native function.
+	*
+	* @example
+	* var bool = reNativeFunction.REGEXP.test( Date.toString() );
+	* // returns true
+	*/
+	REGEXP: RegExp;
+}
+
+/**
+* Returns a regular expression to match a native function.
+*
+* @returns regular expression
+*
+* @example
+* var RE_NATIVE_FUNCTION = reNativeFunction();
+* var bool = RE_NATIVE_FUNCTION.test( Date.toString() );
+* // returns true
+*
+* @example
+* var bool = reNativeFunction.REGEXP.test( Date.toString() );
+* // returns true
+*/
+declare var reNativeFunction: ReNativeFunction;
+
+
+// EXPORTS //
+
+export = reNativeFunction;

lib/node_modules/@stdlib/regexp/native-function/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 reNativeFunction = require( './index' );
+
+
+// TESTS //
+
+// The function returns a regular expression...
+{
+	reNativeFunction(); // $ExpectType RegExp
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	reNativeFunction( 1 ); // $ExpectError
+	reNativeFunction( 1, 2 ); // $ExpectError
+}
+
+// Attached to main export is a `REGEXP` property that is a regular expression...
+{
+	// tslint:disable-next-line:no-unused-expression
+	reNativeFunction.REGEXP; // $ExpectType RegExp
+}

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

@@ -21,8 +21,9 @@
 'use strict';
 
 var Int8Array = require( '@stdlib/array/int8' );
-var RE_NATIVE_FUNCTION = require( './../lib' );
+var reNativeFunction = require( './../lib' );
 
+var RE_NATIVE_FUNCTION = reNativeFunction();
 function isNativeFunction( fcn ) {
 	return RE_NATIVE_FUNCTION.test( fcn.toString() );
 }

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

@@ -19,14 +19,14 @@
 'use strict';
 
 /**
-* Regular expression to match a native function.
+* Return a regular expression to match a native function.
 *
 * @module @stdlib/regexp/native-function
-* @type {RegExp}
 *
 * @example
-* var RE_NATIVE_FUNCTION = require( '@stdlib/regexp/native-function' );
+* var reNativeFunction = require( '@stdlib/regexp/native-function' );
 *
+* var RE_NATIVE_FUNCTION = reNativeFunction();
 * function isNativeFunction( fcn ) {
 *     return RE_NATIVE_FUNCTION.test( fcn.toString() );
 * }
@@ -47,15 +47,21 @@
 
 // MAIN //
 
-/**
-* Match a native function.
-*
-* @constant
-* @type {RegExp}
-*/
-var RE_NATIVE_FUNCTION = require( './regexp.js' );
+var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
+var reNativeFunction = require( './main.js' );
+var REGEXP = require( './regexp.js' );
+
+
+// MAIN //
+
+setReadOnly( reNativeFunction, 'REGEXP', REGEXP );
+
+
+// EXPORTS //
+
+module.exports = reNativeFunction;
 
 
 // EXPORTS //
 
-module.exports = RE_NATIVE_FUNCTION;
+module.exports = reNativeFunction;

lib/node_modules/@stdlib/regexp/native-function/lib/main.js

@@ -0,0 +1,55 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Returns a regular expression to capture everything that is not a space immediately after the `function` keyword and before the first left parenthesis.
+*
+* @returns {RegExp} regular expression
+*
+* @example
+* var RE_NATIVE_FUNCTION = reNativeFunction();
+* var bool = RE_NATIVE_FUNCTION.test( Date.toString() );
+* // returns true
+*/
+function reNativeFunction() {
+	var str = '';
+
+	// Use a native function as a template:
+	str += Function.prototype.toString.call( Function );
+
+	// Escape special RegExp characters:
+	str = str.replace( /([.*+?^=!:$(){}|[\]\/\\])/g, '\\$1' ); // eslint-disable-line no-useless-escape
+
+	// Replace any mentions of `Function` to make template generic and replace `for ...` and additional info provided in other environments, such as Rhino.
+	str = str.replace( /Function|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?' );
+
+	// Bracket the regular expression:
+	str = '^' + str + '$';
+
+	// Create the regular expression:
+	return new RegExp( str );
+}
+
+
+// EXPORTS //
+
+module.exports = reNativeFunction;

lib/node_modules/@stdlib/regexp/native-function/lib/regexp.js

@@ -18,29 +18,22 @@
 
 'use strict';
 
-// MAIN //
-
-var str;
-var re;
-
-str = '';
-
-// Use a native function as a template:
-str += Function.prototype.toString.call( Function );
+// MODULES //
 
-// Escape special RegExp characters:
-str = str.replace( /([.*+?^=!:$(){}|[\]\/\\])/g, '\\$1' ); // eslint-disable-line no-useless-escape
+var reNativeFunction = require( './main.js' );
 
-// Replace any mentions of `Function` to make template generic and replace `for ...` and additional info provided in other environments, such as Rhino.
-str = str.replace( /Function|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?' );
 
-// Bracket the regular expression:
-str = '^' + str + '$';
+// MAIN //
 
-// Create the regular expression:
-re = new RegExp( str );
+/**
+* Match a native function.
+*
+* @constant
+* @type {RegExp}
+*/
+var RE_NATIVE_FUNCTION = reNativeFunction();
 
 
 // EXPORTS //
 
-module.exports = re;
+module.exports = RE_NATIVE_FUNCTION;

lib/node_modules/@stdlib/regexp/native-function/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/regexp/native-function",
   "version": "0.0.0",
-  "description": "Regular expression to match a native function.",
+  "description": "Return a regular expression to match a native function.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {