feat!: update ndarray TypeScript declarations

This commit updates the `concat` API to accept an options argument rather than a `dim` argument. To specify a dimension, one should pass in an options object with a `dim` property.

BREAKING CHANGE: move `dim` argument to option

To migrate, users wanting to specify a dimension along which to concatenate input arrays should provide an object containing a `dim` property.

PR-URL: #9508
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: stdlib-bot

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

@@ -489,11 +489,10 @@ interface Namespace {
 	* Concatenates a list of ndarrays along a specified ndarray dimension.
 	*
 	* @param arrays - array-like object containing input ndarrays
-	* @param dim - dimension along which to concatenate input ndarrays
+	* @param options - function options
 	* @returns output ndarray
 	*
 	* @example
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var Float64Array = require( '@stdlib/array/float64' );
 	* var ndarray = require( '@stdlib/ndarray/ctor' );
 	*
@@ -503,14 +502,12 @@ interface Namespace {
 	* var ybuf = new Float64Array( [ -5.0, 6.0, -7.0, 8.0, -9.0, 10.0 ] );
 	* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
 	*
-	* var out = ns.concat( [ x, y ], -1 );
-	* // returns <ndarray>
-	*
-	* var arr = ndarray2array( out );
-	* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
+	* var out = ns.concat( [ x, y ], {
+	*     'dim': -1
+	* });
+	* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
 	*
 	* @example
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var Float64Array = require( '@stdlib/array/float64' );
 	* var ndarray = require( '@stdlib/ndarray/ctor' );
 	*
@@ -522,13 +519,13 @@ interface Namespace {
 	*
 	* var z = new ndarray( 'float64', new Float64Array( 10 ), [ 2, 5 ], [ 5, 1 ], 0, 'row-major' );
 	*
-	* var out = ns.concat.assign( [ x, y ], z, -1 );
+	* var out = ns.concat.assign( [ x, y ], z, {
+	*     'dim': -1
+	* });
+	* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
 	*
 	* var bool = ( out === z );
 	* // returns true
-	*
-	* var arr = ndarray2array( z );
-	* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
 	*/
 	concat: typeof concat;