Merge branch 'stdlib-js:develop' into tests-some-by

Author: headlessNode

.github/workflows/namespace_declarations.yml

@@ -115,6 +115,15 @@ jobs:
 
               # Branch name slug with slashes replaced by dashes:
               branch_name="update-${display_namespace//\//-}-declarations"
+
+              # If an open PR already exists for this branch, skip this namespace entirely:
+              existing_pr=$(gh pr list --head "$branch_name" --state open --json number -q '.[0].number' || true)
+              if [ -n "$existing_pr" ]; then
+                echo "Open PR exists for $branch_name (#$existing_pr). Skipping $namespace."
+                continue
+              fi
+
+              # Switch to the new branch:
               git checkout -b "$branch_name"
 
               # Generate declarations for this namespace:

lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js

@@ -18,7 +18,7 @@
 * limitations under the License.
 */
 
-/* eslint-disable node/no-sync, no-console */
+/* eslint-disable node/no-sync, no-console, max-statements */
 
 'use strict';
 
@@ -44,6 +44,54 @@ var RE_TS_EXPORT = /export = ([^;]+);/;
 var RE_EXAMPLE = /@example[\s\S]*?(?=@example|\*\/)/g;
 var RE_NAMESPACE = /@namespace ([a-z.0-9]+)/i;
 var RE_COPYRIGHT_YEAR = /Copyright \(c\) (\d{4}) The Stdlib Authors\./;
+var RESERVED_WORDS = [
+	'break',
+	'case',
+	'catch',
+	'class',
+	'const',
+	'continue',
+	'debugger',
+	'default',
+	'delete',
+	'do',
+	'else',
+	'export',
+	'extends',
+	'false',
+	'finally',
+	'for',
+	'function',
+	'if',
+	'import',
+	'in',
+	'instanceof',
+	'new',
+	'null',
+	'return',
+	'super',
+	'switch',
+	'this',
+	'throw',
+	'true',
+	'try',
+	'typeof',
+	'var',
+	'void',
+	'while',
+	'with',
+	'let',
+	'static',
+	'yield',
+	'await',
+	'enum',
+	'implements',
+	'interface',
+	'package',
+	'private',
+	'protected',
+	'public'
+];
 
 
 // FUNCTIONS //
@@ -175,6 +223,7 @@ function create( fullPath ) {
 	var tsDefPath;
 	var testFile;
 	var typesDir;
+	var safeName;
 	var defFile;
 	var pkgPath;
 	var match;
@@ -237,11 +286,16 @@ function create( fullPath ) {
 	}
 	while ( match !== null ) {
 		name = match[ 1 ];
+		if ( contains( RESERVED_WORDS, name ) ) {
+			safeName = '_' + name;
+		} else {
+			safeName = name;
+		}
 		pkgPath = match[ 2 ];
 
 		tsDefPath = replace( require.resolve( pkgPath ), 'lib/index.js', 'docs/types/index.d.ts' );
 		if ( fs.existsSync( tsDefPath ) ) {
-			stmt = replace( IMPORT_STATEMENT, '<name>', name );
+			stmt = replace( IMPORT_STATEMENT, '<name>', safeName );
 			stmt = replace( stmt, '<path>', pkgPath );
 			importStmts.push( stmt );
 
@@ -253,7 +307,7 @@ function create( fullPath ) {
 			if ( !tsDoc ) {
 				tsDoc = tsDef.match( /(\/\*\*\n[^/]+?\*\/)\ndeclare class/ );
 			}
-			prop = '\t'+name+': typeof '+name+';';
+			prop = '\t'+name+': typeof '+safeName+';';
 			if ( tsDoc && tsDoc[ 1 ] ) {
 				str = tsDoc[ 1 ];
 				str = replace( str, RE_EXAMPLE, onReplace );

lib/node_modules/@stdlib/array/base/docs/types/index.d.ts

@@ -742,7 +742,7 @@ interface Namespace {
 	* var x = [ 'beep', 'boop', 'foo', 'bar' ];
 	* var filter = [ true, true, false, true ];
 	*
-	* var out = ns.bifurcateEntries( arr, filter );
+	* var out = ns.bifurcateEntries( x, filter );
 	* // returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]
 	*/
 	bifurcateEntries: typeof bifurcateEntries;
@@ -822,7 +822,7 @@ interface Namespace {
 	* var x = [ 'beep', 'boop', 'foo', 'bar' ];
 	* var filter = [ true, true, false, true ];
 	*
-	* var out = ns.bifurcateValues( arr, filter );
+	* var out = ns.bifurcateValues( x, filter );
 	* // returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
 	*/
 	bifurcateValues: typeof bifurcateValues;
@@ -2138,16 +2138,16 @@ interface Namespace {
 	*
 	* @example
 	* function fcn( v ) {
-	* 	return v > 0;
+	*     return v > 0;
 	* }
 	* var x = [ 1, 1, 0, 0, 0 ];
 	*
-	* var result = cunoneByright( x, fcn );
+	* var result = ns.cunoneByRight( x, fcn );
 	* // returns [ true, true, true, false, false ]
 	*
 	* @example
 	* function fcn( v ) {
-	* 	return v > 0;
+	*     return v > 0;
 	* }
 	* var x = [ 0, 1, 1, 0, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
@@ -2734,7 +2734,7 @@ interface Namespace {
 	* @example
 	* var arr = [ 1, 2, 3 ];
 	*
-	* var out = ns.first( x );
+	* var out = ns.first( arr );
 	* // returns 1
 	*/
 	first: typeof first;
@@ -3537,7 +3537,7 @@ interface Namespace {
 	* @example
 	* var arr = [ 1, 2, 3 ];
 	*
-	* var out = ns.last( x );
+	* var out = ns.last( arr );
 	* // returns 3
 	*/
 	last: typeof last;
@@ -4014,7 +4014,7 @@ interface Namespace {
 	*
 	* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
 	*
-	* mskbinary2d( [ x, y, mask, z ], shape, add );
+	* ns.mskbinary4d( [ x, y, mask, z ], shape, add );
 	*
 	* console.log( z );
 	* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ]
@@ -4946,6 +4946,8 @@ interface Namespace {
 	* @returns output array
 	*
 	* @example
+	* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
+	*
 	* var x = [ 1, -2, -3, 4 ];
 	*
 	* var out = ns.reject( x, isPositiveNumber );
@@ -5976,7 +5978,7 @@ interface Namespace {
 	* var x = ones5d( shape );
 	* var y = zeros5d( shape );
 	*
-	* unary2dBy( [ x, y ], shape, scale );
+	* ns.unary5dBy( [ x, y ], shape, scale );
 	*
 	* console.log( y );
 	* // => [ [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ] ]