Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -431,6 +431,7 @@
 
 ### Bug Fixes
 
+-   [`2848c77`](https://github.com/stdlib-js/stdlib/commit/2848c77bb0cf8fd2fc78fe72095a1aad2e545a36) - improve type specificity, remove unreachable path, and fix docs
 -   [`5b491c9`](https://github.com/stdlib-js/stdlib/commit/5b491c98f454c2413c23eaa901543bef9e3642f2) - allow enums to be nonpositive integers
 -   [`a278663`](https://github.com/stdlib-js/stdlib/commit/a2786634547c68e950444c8a16d522d2ab79e335) - ensure \"generic\" data type objects are considered valid
 -   [`f8e5205`](https://github.com/stdlib-js/stdlib/commit/f8e520591bc2a8d8436ebb4fbe1604a7376105cd) - use correct `sliceAssign` alias
@@ -591,6 +592,7 @@ A total of 24 issues were closed in this release:
 
 <details>
 
+-   [`2848c77`](https://github.com/stdlib-js/stdlib/commit/2848c77bb0cf8fd2fc78fe72095a1aad2e545a36) - **fix:** improve type specificity, remove unreachable path, and fix docs _(by Athan Reines)_
 -   [`b5a916e`](https://github.com/stdlib-js/stdlib/commit/b5a916e413d8658977ab2383ec6fe411f90c557d) - **feat:** update `ndarray/base` TypeScript declarations [(#8127)](https://github.com/stdlib-js/stdlib/pull/8127) _(by stdlib-bot)_
 -   [`5c3691e`](https://github.com/stdlib-js/stdlib/commit/5c3691efad0d8f75effc471424caa0473cb264ac) - **test:** add tests to `ndarray/every` for complete test coverage [(#8124)](https://github.com/stdlib-js/stdlib/pull/8124) _(by Muhammad Haris, Athan Reines)_
 -   [`5b42c46`](https://github.com/stdlib-js/stdlib/commit/5b42c466e82c41e5ef0d52bac26a1d4fa03ac31a) - **test:** fix description _(by Athan Reines)_

some-by/docs/repl.txt

@@ -28,7 +28,7 @@
     predicate: Function
         Predicate function.
 
-    thisArg: Any (optional)
+    thisArg: any (optional)
         Predicate execution context.
 
     Returns
@@ -55,7 +55,8 @@
 
 {{alias}}.assign( x, n, y[, options], predicate[, thisArg] )
     Tests whether at least `n` elements along one or more ndarray dimensions
-    pass a test implemented by a predicate function.
+    pass a test implemented by a predicate function and assigns the results to
+    a provided output ndarray.
 
     Parameters
     ----------
@@ -79,14 +80,10 @@
         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
-        the returned ndarray as singleton dimensions. Default: false.
-
     predicate: Function
         Predicate function.
 
-    thisArg: Any (optional)
+    thisArg: any (optional)
         Predicate execution context.
 
     Returns

some-by/docs/types/index.d.ts

@@ -23,6 +23,11 @@
 import { ArrayLike } from '@stdlib/types/array';
 import { ndarray, boolndarray, integerndarray, 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.
@@ -127,7 +132,7 @@ interface SomeBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	<T = unknown, U = unknown>( x: ndarray, n: integerndarray | number, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolndarray;
+	<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, n: integerndarray | number, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): boolndarray;
 
 	/**
 	* Tests whether at least `n` elements along one or more ndarray dimensions pass a test implemented by a predicate function.
@@ -168,7 +173,7 @@ interface SomeBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	<T = unknown, U = unknown>( x: ndarray, n: integerndarray | number, options: Options, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolndarray;
+	<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, n: integerndarray | number, options: Options, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): boolndarray;
 
 	/**
 	* Tests whether at least `n` elements along one or more ndarray dimensions pass a test implemented by a predicate function.
@@ -213,7 +218,7 @@ interface SomeBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	assign<T = unknown, U extends ndarray = ndarray, V = unknown>( x: ndarray, n: integerndarray | number, 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: ndarray, n: integerndarray | number, y: V, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
 
 	/**
 	* Tests whether at least `n` elements along one or more ndarray dimensions pass a test implemented by a predicate function.
@@ -260,7 +265,7 @@ interface SomeBy {
 	* var v = out.get();
 	* // returns true
 	*/
-	assign<T = unknown, U extends ndarray = ndarray, V = unknown>( x: ndarray, n: integerndarray | number, 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: ndarray, n: integerndarray | number, y: V, options: BaseOptions, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
 }
 
 /**

some-by/lib/main.js

@@ -70,7 +70,7 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
 * @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
 *

some-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;