feat: update namespace TypeScript declarations

stdlib-bot · kgryte · web-flow · commit cd14ed3f1bbc · 2024-06-18T10:28:52.000-07:00
PR-URL: stdlib-js#2402 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
diff --git a/lib/node_modules/@stdlib/array/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/docs/types/index.d.ts
@@ -66,6 +66,7 @@ import ones = require( '@stdlib/array/ones' );
 import onesLike = require( '@stdlib/array/ones-like' );
 import typedarraypool = require( '@stdlib/array/pool' );
 import promotionRules = require( '@stdlib/array/promotion-rules' );
+import put = require( '@stdlib/array/put' );
 import typedarrayReviver = require( '@stdlib/array/reviver' );
 import safeCasts = require( '@stdlib/array/safe-casts' );
 import sameKindCasts = require( '@stdlib/array/same-kind-casts' );
@@ -1169,6 +1170,38 @@ interface Namespace {
 	*/
 	promotionRules: typeof promotionRules;
 
+	/**
+	* Replaces specified elements of an array with provided values.
+	*
+	* @param x - input array
+	* @param indices - list of element indices
+	* @param values - values to set
+	* @param options - function options
+	* @returns input array
+	*
+	* @example
+	* var x = [ 1, 2, 3, 4 ];
+	*
+	* var indices = [ 1, 2 ];
+	* var values = [ 20, 30 ];
+	*
+	* var out = ns.put( x, indices, values );
+	* // returns [ 1, 20, 30, 4 ]
+	*
+	* var bool = ( out === x );
+	* // returns true
+	*
+	* @example
+	* var x = [ 1, 2, 3, 4 ];
+	*
+	* var out = ns.put( x, [ 1, 2 ], [ 30 ] );
+	* // returns [ 1, 30, 30, 4 ]
+	*
+	* var bool = ( out === x );
+	* // returns true
+	*/
+	put: typeof put;
+
 	/**
 	* Revives a JSON-serialized typed array.
 	*
