chore: clean-up

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/any-by/docs/repl.txt

@@ -1,3 +1,4 @@
+
 {{alias}}( x[, options], predicate[, thisArg] )
     Tests whether at least one element along one or more ndarray dimensions
     passes a test implemented by a predicate function.
@@ -11,7 +12,9 @@
         Function options.
 
     options.dims: Array<integer> (optional)
-        List of dimensions over which to perform a reduction. Default: null.
+        List of dimensions over which to perform a reduction. If not provided,
+        the function performs a reduction over all elements in a provided input
+        ndarray.
 
     options.keepdims: boolean (optional)
         Boolean indicating whether the reduced dimensions should be included in
@@ -26,7 +29,8 @@
     Returns
     -------
     out: ndarray
-        Output ndarray.
+        Output ndarray. When performing a reduction over all elements, the
+        function returns a zero-dimensional ndarray containing the result.
 
     Examples
     --------
@@ -41,7 +45,7 @@
 
 {{alias}}.assign( x, y[, options], predicate[, thisArg] )
     Tests whether at least one element along one or more ndarray dimensions
-    passes a test implemented by a predicate function and assigns the result to
+    passes a test implemented by a predicate function and assigns the results to
     a provided output ndarray.
 
     Parameters
@@ -50,13 +54,16 @@
         Input ndarray.
 
     y: ndarray
-        Output ndarray.
+        Output ndarray. The output shape must match the shape of the non-reduced
+        dimensions of the input ndarray.
 
     options: Object (optional)
         Function options.
 
     options.dims: Array<integer> (optional)
-        List of dimensions over which to perform a reduction. Default: null.
+        List of dimensions over which to perform a reduction. If not provided,
+        the function performs a reduction over all elements in a provided input
+        ndarray.
 
     predicate: Function
         Predicate function.

lib/node_modules/@stdlib/ndarray/any-by/docs/types/index.d.ts

@@ -23,6 +23,11 @@
 import { ArrayLike } from '@stdlib/types/array';
 import { ndarray, boolndarray, typedndarray } from '@stdlib/types/ndarray';
 
+/**
+* Input array.
+*/
+type InputArray<T> = typedndarray<T>;
+
 /**
 * Returns a boolean indicating whether an element passes a test.
 *
@@ -55,7 +60,7 @@ type Binary<T, ThisArg> = ( this: ThisArg, value: T, indices: Array<number> ) =>
 * @param arr - input array
 * @returns boolean indicating whether an ndarray element passes a test
 */
-type Ternary<T, ThisArg> = ( this: ThisArg, value: T, indices: Array<number>, arr: typedndarray<T> ) => boolean;
+type Ternary<T, U, ThisArg> = ( this: ThisArg, value: T, indices: Array<number>, arr: U ) => boolean;
 
 /**
 * Returns a boolean indicating whether an element passes a test.
@@ -65,7 +70,7 @@ type Ternary<T, ThisArg> = ( this: ThisArg, value: T, indices: Array<number>, ar
 * @param arr - input array
 * @returns boolean indicating whether an ndarray element passes a test
 */
-type Predicate<T, ThisArg> = Nullary<ThisArg> | Unary<T, ThisArg> | Binary<T, ThisArg> | Ternary<T, ThisArg>;
+type Predicate<T, U, ThisArg> = Nullary<ThisArg> | Unary<T, ThisArg> | Binary<T, ThisArg> | Ternary<T, U, ThisArg>;
 
 /**
 * Base options.
@@ -129,7 +134,7 @@ interface AnyBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	<T = unknown, U = unknown>( x: ndarray, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolndarray;
+	<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): boolndarray;
 
 	/**
 	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function.
@@ -172,7 +177,7 @@ interface AnyBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	<T = unknown, U = unknown>( x: ndarray, options: Options, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolndarray;
+	<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): boolndarray;
 
 	/**
 	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function.
@@ -219,7 +224,7 @@ interface AnyBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	assign<T = unknown, U extends ndarray = ndarray, V = unknown>( x: ndarray, y: U, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): U;
+	assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends ndarray = ndarray, ThisArg = unknown>( x: U, y: V, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
 
 	/**
 	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function.
@@ -268,7 +273,7 @@ interface AnyBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	assign<T = unknown, U extends ndarray = ndarray, V = unknown>( x: ndarray, y: U, options: BaseOptions, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): U;
+	assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends ndarray = ndarray, ThisArg = unknown>( x: U, y: V, options: BaseOptions, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
 }
 
 /**

lib/node_modules/@stdlib/ndarray/any-by/docs/types/test.ts

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable space-in-parens */
+
 import zeros = require( '@stdlib/ndarray/zeros' );
 import empty = require( '@stdlib/ndarray/empty' );
 import anyBy = require( './index' );
@@ -161,15 +163,7 @@ function clbk( value: number ): boolean {
 	const x = zeros( [ 2, 2 ] );
 	const y = empty( [], {
 		'dtype': 'bool'
-	} );
-
-	anyBy.assign( x, y, clbk ); // $ExpectType boolndarray
-	anyBy.assign( x, y, {}, clbk ); // $ExpectType boolndarray
-	anyBy.assign( x, y, { 'dims': [ 0 ] }, clbk ); // $ExpectType boolndarray
-
-	anyBy.assign( x, y, clbk, {} ); // $ExpectType boolndarray
-	anyBy.assign( x, y, {}, clbk, {} ); // $ExpectType boolndarray
-	anyBy.assign( x, y, { 'dims': [ 0 ] }, clbk, {} ); // $ExpectType boolndarray
+	});
 
 	anyBy.assign( x, y, clbk ); // $ExpectType boolndarray
 	anyBy.assign( x, y, {}, clbk ); // $ExpectType boolndarray
@@ -184,7 +178,7 @@ function clbk( value: number ): boolean {
 {
 	const y = empty( [], {
 		'dtype': 'bool'
-	} );
+	});
 
 	anyBy.assign( 5, y, clbk ); // $ExpectError
 	anyBy.assign( true, y, clbk ); // $ExpectError
@@ -223,7 +217,7 @@ function clbk( value: number ): boolean {
 	anyBy.assign( ( x: number ): number => x, y, {}, clbk, {} ); // $ExpectError
 }
 
-// The compiler throws an error if the `assign` method is provided an output argument which is not an ndarray...
+// The compiler throws an error if the `assign` method is provided a second argument which is not an ndarray...
 {
 	const x = zeros( [ 2, 2 ] );
 
@@ -269,7 +263,7 @@ function clbk( value: number ): boolean {
 	const x = zeros( [ 2, 2 ] );
 	const y = empty( [], {
 		'dtype': 'bool'
-	} );
+	});
 
 	anyBy.assign( x, y, '5', clbk ); // $ExpectError
 	anyBy.assign( x, y, 5, clbk ); // $ExpectError
@@ -293,7 +287,7 @@ function clbk( value: number ): boolean {
 	const x = zeros( [ 2, 2 ] );
 	const y = empty( [], {
 		'dtype': 'int32'
-	} );
+	});
 
 	anyBy.assign( x, y, '5' ); // $ExpectError
 	anyBy.assign( x, y, 5 ); // $ExpectError
@@ -333,7 +327,7 @@ function clbk( value: number ): boolean {
 	const x = zeros( [ 2, 2 ] );
 	const y = empty( [], {
 		'dtype': 'bool'
-	} );
+	});
 
 	anyBy.assign( x, y, { 'dims': '5' }, clbk ); // $ExpectError
 	anyBy.assign( x, y, { 'dims': 5 }, clbk ); // $ExpectError
@@ -357,7 +351,7 @@ function clbk( value: number ): boolean {
 	const x = zeros( [ 2, 2 ] );
 	const y = empty( [], {
 		'dtype': 'bool'
-	} );
+	});
 
 	anyBy.assign(); // $ExpectError
 	anyBy.assign( x ); // $ExpectError

lib/node_modules/@stdlib/ndarray/any-by/lib/main.js

@@ -57,7 +57,7 @@ var validate = require( './validate.js' );
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} callback argument must be a function
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
-* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
+* @throws {Error} dimension indices must be unique
 * @throws {Error} must provide valid options
 * @returns {ndarray} output ndarray
 *

lib/node_modules/@stdlib/ndarray/any-by/lib/validate.js

@@ -76,9 +76,6 @@ function validate( opts, ndims, options ) {
 		if ( tmp.length !== opts.dims.length ) {
 			return new Error( format( 'invalid option. `%s` option contains duplicate indices. Option: [%s].', 'dims', join( opts.dims, ',' ) ) );
 		}
-		if ( tmp.length > ndims ) {
-			return new RangeError( format( 'invalid option. `%s` option specifies more dimensions than exists in the input array. Number of dimensions: %d. Option: [%s].', 'dims', ndims, join( opts.dims, ',' ) ) );
-		}
 		opts.dims = tmp;
 	}
 	return null;