Skip to content

Commit e22b37a

Browse files
committed
docs: add example
1 parent 1f1c2df commit e22b37a

File tree

1 file changed

+12
-0
lines changed
  • lib/node_modules/@stdlib/array/base/with/docs/types

1 file changed

+12
-0
lines changed

lib/node_modules/@stdlib/array/base/with/docs/types/index.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,18 @@ interface ArrayWith {
230230
*
231231
* var out = arrayWith( x, 1, 8 );
232232
* // returns [ 1, 8, 3, 4, 5, 6 ]
233+
*
234+
* @example
235+
* var Float64Array = require( '@stdlib/array/float64' );
236+
*
237+
* var x = [ 1, 2, 3, 4 ];
238+
*
239+
* var out = new Float64Array( [ 0, 0, 0, 0 ] );
240+
* var arr = arrayWith.assign( x, 0, 5, out, 1, 0 );
241+
* // returns <Float64Array>[ 5, 2, 3, 4 ]
242+
*
243+
* var bool = ( arr === out );
244+
* // returns true
233245
*/
234246
declare var arrayWith: ArrayWith;
235247

0 commit comments

Comments
 (0)