Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -380,6 +380,7 @@
 
 ### Bug Fixes
 
+-   [`6d74243`](https://github.com/stdlib-js/stdlib/commit/6d742438beb8e7fe0de4ecfbc82083da16a0a83c) - ensure correct type when providing a `dtype` option
 -   [`57a9400`](https://github.com/stdlib-js/stdlib/commit/57a9400329d0570d2b25ad6b87d4d9a74d7fc28b) - avoid strict equality check
 -   [`d5e1c28`](https://github.com/stdlib-js/stdlib/commit/d5e1c28e6821d21da0b79090ebd3cf903f036aae) - maintain floating-point precision
 -   [`8983f46`](https://github.com/stdlib-js/stdlib/commit/8983f46c72781a991814dcf9a6e08db27cd12e39) - use correct variable
@@ -531,6 +532,7 @@ A total of 24 issues were closed in this release:
 
 <details>
 
+-   [`6d74243`](https://github.com/stdlib-js/stdlib/commit/6d742438beb8e7fe0de4ecfbc82083da16a0a83c) - **fix:** ensure correct type when providing a `dtype` option _(by Athan Reines)_
 -   [`0ed631d`](https://github.com/stdlib-js/stdlib/commit/0ed631d96dae3b796882c441f79505275afbc4c0) - **feat:** add `dtype` option support in `ndarray/flatten` [(#8091)](https://github.com/stdlib-js/stdlib/pull/8091) _(by Muhammad Haris, Athan Reines)_
 -   [`724283b`](https://github.com/stdlib-js/stdlib/commit/724283b0bc5d2eb8bf48491c954c6a119330c1f5) - **feat:** add `ndarray/base/nullary-strided1d-dispatch-factory` [(#7828)](https://github.com/stdlib-js/stdlib/pull/7828) _(by Muhammad Haris, Athan Reines, stdlib-bot)_
 -   [`2743732`](https://github.com/stdlib-js/stdlib/commit/27437323cb1d22c53c91f152d6d05153630bc123) - **docs:** fix description _(by Athan Reines)_

flatten/docs/types/index.d.ts

@@ -20,12 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ndarray, Order, DataType } from '@stdlib/types/ndarray';
+import { ndarray, typedndarray, Order, DataTypeMap } from '@stdlib/types/ndarray';
 
 /**
-* Interface defining function options.
+* Interface defining "base" function options.
 */
-interface Options {
+interface BaseOptions {
 	/**
 	* Maximum number of dimensions to flatten.
 	*
@@ -50,16 +50,47 @@ interface Options {
 	* -   Default: 'row-major'.
 	*/
 	order?: Order | 'same' | 'any';
+}
 
+/**
+* Function options.
+*/
+type Options<U> = BaseOptions & {
 	/**
 	* Output ndarray data type.
-	*
-	* ## Notes
-	*
-	* -   By default, the function returns an ndarray having the same data type as a provided input ndarray.
 	*/
-	dtype?: DataType;
-}
+	dtype: U;
+};
+
+/**
+* Returns a flattened copy of an input ndarray.
+*
+* ## Notes
+*
+* -   The function **always** returns a copy of input ndarray data, even when an input ndarray already has the desired number of dimensions.
+* -   By default, the function returns an ndarray having the same data type as a provided input ndarray.
+*
+* @param x - input ndarray
+* @param options - function options
+* @param options.depth - maximum number of dimensions to flatten
+* @param options.order - order in which input ndarray elements should be flattened
+* @param options.dtype - output ndarray data type
+* @returns output ndarray
+*
+* @example
+* var array = require( '@stdlib/ndarray/array' );
+* var ndarray2array = require( '@stdlib/ndarray/to-array' );
+*
+* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
+* // return <ndarray>
+*
+* var y = flatten( x );
+* // returns <ndarray>
+*
+* var arr = ndarray2array( y );
+* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+*/
+declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;
 
 /**
 * Returns a flattened copy of an input ndarray.
@@ -72,6 +103,7 @@ interface Options {
 * @param options - function options
 * @param options.depth - maximum number of dimensions to flatten
 * @param options.order - order in which input ndarray elements should be flattened
+* @param options.dtype - output ndarray data type
 * @returns output ndarray
 *
 * @example
@@ -87,7 +119,7 @@ interface Options {
 * var arr = ndarray2array( y );
 * // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
-declare function flatten<T extends ndarray>( x: T, options?: Options ): T;
+declare function flatten<T = unknown, U extends keyof DataTypeMap<T> = 'generic'>( x: typedndarray<T>, options: Options<U> ): DataTypeMap<T>[U];
 
 
 // EXPORTS //

flatten/docs/types/test.ts

@@ -31,6 +31,10 @@ import flatten = require( './index' );
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), {} ); // $ExpectType float64ndarray
 	flatten( zeros( 'complex128', [ 2, 2, 2 ], 'row-major' ), {} ); // $ExpectType complex128ndarray
 	flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), {} ); // $ExpectType genericndarray<number>
+
+	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'dtype': 'float32' } ); // $ExpectType float32ndarray
+	flatten( zeros( 'int32', [ 2, 2, 2 ], 'row-major' ), { 'dtype': 'float64' } ); // $ExpectType float64ndarray
+	flatten( zeros( 'int32', [ 2, 2, 2 ], 'row-major' ), { 'dtype': 'generic' } ); // $ExpectType genericndarray<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an ndarray-like object...