feat: update ndarray/base TypeScript declarations

stdlib-bot · stdlib-bot · commit 711915d88ca9 · 2025-12-27T02:43:12.000Z
Signed-off-by: stdlib-bot &lt;82920195+stdlib-bot@users.noreply.github.com&gt;
diff --git a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
@@ -3870,6 +3870,7 @@ interface Namespace {
 	* @param ndims - number of dimensions in the output array
 	* @param x - input array
 	* @param dims - dimension indices
+	* @param writable - boolean indicating whether a returned array should be writable
 	* @returns output array
 	*
 	* @example
@@ -3881,7 +3882,7 @@ interface Namespace {
 	* var shx = x.shape;
 	* // returns [ 2, 2 ]
 	*
-	* var y = ns.spreadDimensions( 5, x, [ 1, 3 ] );
+	* var y = ns.spreadDimensions( 5, x, [ 1, 3 ], false );
 	* // returns <ndarray>
 	*
 	* var shy = y.shape;

Original file line number	Diff line number	Diff line change
`@@ -3870,6 +3870,7 @@ interface Namespace {`
`3870`	`3870`	`* @param ndims - number of dimensions in the output array`
`3871`	`3871`	`* @param x - input array`
`3872`	`3872`	`* @param dims - dimension indices`
	`3873`	`+ * @param writable - boolean indicating whether a returned array should be writable`
`3873`	`3874`	`* @returns output array`
`3874`	`3875`	`*`
`3875`	`3876`	`* @example`
`@@ -3881,7 +3882,7 @@ interface Namespace {`
`3881`	`3882`	`* var shx = x.shape;`
`3882`	`3883`	`* // returns [ 2, 2 ]`
`3883`	`3884`	`*`
`3884`		`- * var y = ns.spreadDimensions( 5, x, [ 1, 3 ] );`
	`3885`	`+ * var y = ns.spreadDimensions( 5, x, [ 1, 3 ], false );`
`3885`	`3886`	`* // returns <ndarray>`
`3886`	`3887`	`*`
`3887`	`3888`	`* var shy = y.shape;`