Auto-generated commit

stdlib-bot · stdlib-bot · commit b2a63e40fde1 · 2024-04-07T10:25:23.000Z
diff --git a/README.md b/README.md
@@ -235,6 +235,7 @@ The namespace exports the following:
 -   <span class="signature">[`unary5d( arrays, shape, fcn )`][@stdlib/array/base/unary5d]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a five-dimensional nested input array and assign results to elements in a five-dimensional nested output array.</span>
 -   <span class="signature">[`unarynd( arrays, shape, fcn )`][@stdlib/array/base/unarynd]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in an n-dimensional nested input array and assign results to elements in an n-dimensional nested output array.</span>
 -   <span class="signature">[`unitspace( start, stop )`][@stdlib/array/base/unitspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1.</span>
+-   <span class="signature">[`arrayWith( x, index, value )`][@stdlib/array/base/with]</span><span class="delimiter">: </span><span class="description">return a new array with the element at the specified index replaced with a provided value.</span>
 -   <span class="signature">[`zeroTo( n )`][@stdlib/array/base/zero-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1 starting from zero.</span>
 -   <span class="signature">[`zeros( len )`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled "generic" array.</span>
 -   <span class="signature">[`zeros2d( shape )`][@stdlib/array/base/zeros2d]</span><span class="delimiter">: </span><span class="description">create a zero-filled two-dimensional nested array.</span>
@@ -666,6 +667,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/array/base/unitspace]: https://github.com/stdlib-js/array-base-unitspace
 
+[@stdlib/array/base/with]: https://github.com/stdlib-js/array-base-with
+
 [@stdlib/array/base/zero-to]: https://github.com/stdlib-js/array-base-zero-to
 
 [@stdlib/array/base/zeros]: https://github.com/stdlib-js/array-base-zeros
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -177,6 +177,7 @@ import unary4d = require( '@stdlib/array-base-unary4d' );
 import unary5d = require( '@stdlib/array-base-unary5d' );
 import unarynd = require( '@stdlib/array-base-unarynd' );
 import unitspace = require( '@stdlib/array-base-unitspace' );
+import arrayWith = require( '@stdlib/array-base-with' );
 import zeroTo = require( '@stdlib/array-base-zero-to' );
 import zeros = require( '@stdlib/array-base-zeros' );
 import zeros2d = require( '@stdlib/array-base-zeros2d' );
@@ -3996,6 +3997,28 @@ interface Namespace {
 	*/
 	unitspace: typeof unitspace;
 
+	/**
+	* Returns a new array with the element at the specified index replaced with a provided value.
+	*
+	* @param x - input array
+	* @param index - index at which to set a provided value
+	* @param value - replacement value
+	* @returns output array
+	*
+	* @example
+	* var x = [ 1, 2, 3 ];
+	*
+	* var out = ns.arrayWith( x, 0, 7 );
+	* // returns [ 7, 2, 3 ]
+	*
+	* @example
+	* var x = [ 1, 2, 3, 4, 5, 6 ];
+	*
+	* var out = ns.arrayWith( x, 2, 8 );
+	* // returns [ 1, 8, 3, 4, 5, 6 ]
+	*/
+	arrayWith: typeof arrayWith;
+
 	/**
 	* Generates a linearly spaced numeric array whose elements increment by 1 starting from zero.
 	*
