Rename method

kgryte · kgryte · commit 25248b87ae25 · 2021-10-13T12:03:10.000-07:00
diff --git a/lib/node_modules/@stdlib/strided/dtypes/lib/index.js b/lib/node_modules/@stdlib/strided/dtypes/lib/index.js
@@ -35,14 +35,14 @@
 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
 var dtypes = require( './main.js' );
 var enumeration = require( './enum.js' );
-var enumerator = require( './enumerator.js' );
+var str2enum = require( './str2enum.js' );
 var assign = require( './assign.js' );
 
 
 // MAIN //
 
 setReadOnly( dtypes, 'enum', enumeration );
-setReadOnly( dtypes, 'enumerator', enumerator );
+setReadOnly( dtypes, 'str2enum', str2enum );
 assign( dtypes, enumeration() );
 
 
diff --git a/lib/node_modules/@stdlib/strided/dtypes/lib/str2enum.js b/lib/node_modules/@stdlib/strided/dtypes/lib/str2enum.js
@@ -31,25 +31,26 @@ var dt = dtypes();
 // MAIN //
 
 /**
-* Returns the integer value associated with a supported dtype for purposes of C inter-operation.
+* Returns the integer value associated with a supported dtype string for purposes of C inter-operation.
 *
 * ## Notes
 *
 * -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `INT8 == 0`). Instead, the function should be used in an opaque manner.
 * -   The main purpose of this function is JavaScript and C inter-operation of strided arrays.
 *
-* @param {string} dtype - data type
+* @param {string} dtype - data type string
 * @returns {(integer|void)} integer value or undefined
 *
 * @example
-* var v = enumerator( 'int8' );
+* var v = str2enum( 'int8' );
 * // returns <number>
 */
-function enumerator( dtype ) {
-	return dt[ dtype ];
+function str2enum( dtype ) {
+	var v = dt[ dtype ];
+	return ( typeof v === 'number' ) ? v : void 0; // note: we include this guard to prevent walking the prototype chain
 }
 
 
 // EXPORTS //
 
-module.exports = enumerator;
+module.exports = str2enum;
diff --git a/lib/node_modules/@stdlib/strided/dtypes/test/test.js b/lib/node_modules/@stdlib/strided/dtypes/test/test.js
@@ -98,14 +98,14 @@ tape( 'attached to the main function is an `enum` method to return an object map
 	t.end();
 });
 
-tape( 'attached to the main function is an `enumerator` method to the integer value associated with a provided dtype for C inter-operation', function test( t ) {
+tape( 'attached to the main function is a `str2enum` method to retrieve the integer value associated with a provided dtype string for C inter-operation', function test( t ) {
 	var i;
 
-	t.strictEqual( hasOwnProp( dtypes, 'enumerator' ), true, 'has property' );
-	t.strictEqual( typeof dtypes.enumerator, 'function', 'has method' );
+	t.strictEqual( hasOwnProp( dtypes, 'str2enum' ), true, 'has property' );
+	t.strictEqual( typeof dtypes.str2enum, 'function', 'has method' );
 
 	for ( i = 0; i < DTYPES.length; i++ ) {
-		t.strictEqual( isNonNegativeInteger( dtypes.enumerator( DTYPES[i] ) ), true, 'returns expected value' );
+		t.strictEqual( isNonNegativeInteger( dtypes.str2enum( DTYPES[i] ) ), true, 'returns expected value' );
 	}
 	t.end();
 });

Original file line number	Diff line number	Diff line change
`@@ -31,25 +31,26 @@ var dt = dtypes();`
`31`	`31`	`// MAIN //`
`32`	`32`
`33`	`33`	`/**`
`34`		`-* Returns the integer value associated with a supported dtype for purposes of C inter-operation.`
	`34`	`+* Returns the integer value associated with a supported dtype string for purposes of C inter-operation.`
`35`	`35`	`*`
`36`	`36`	`* ## Notes`
`37`	`37`	`*`
`38`	`38`	* - Downstream consumers of this function should not rely on specific integer values (e.g., `INT8 == 0`). Instead, the function should be used in an opaque manner.
`39`	`39`	`* - The main purpose of this function is JavaScript and C inter-operation of strided arrays.`
`40`	`40`	`*`
`41`		`-* @param {string} dtype - data type`
	`41`	`+* @param {string} dtype - data type string`
`42`	`42`	`* @returns {(integer\|void)} integer value or undefined`
`43`	`43`	`*`
`44`	`44`	`* @example`
`45`		`-* var v = enumerator( 'int8' );`
	`45`	`+* var v = str2enum( 'int8' );`
`46`	`46`	`* // returns <number>`
`47`	`47`	`*/`
`48`		`-function enumerator( dtype ) {`
`49`		`- return dt[ dtype ];`
	`48`	`+function str2enum( dtype ) {`
	`49`	`+ var v = dt[ dtype ];`
	`50`	`+ return ( typeof v === 'number' ) ? v : void 0; // note: we include this guard to prevent walking the prototype chain`
`50`	`51`	`}`
`51`	`52`
`52`	`53`
`53`	`54`	`// EXPORTS //`
`54`	`55`
`55`		`-module.exports = enumerator;`
	`56`	`+module.exports = str2enum;`