Skip to content

Commit f5cac6c

Browse files
committed
feat: update doc
1 parent 2a10592 commit f5cac6c

File tree

1 file changed

+21
-0
lines changed
  • lib/node_modules/@stdlib/array/fixed-endian-factory

1 file changed

+21
-0
lines changed

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,27 @@ var len = arr.length;
229229

230230
### Typed Array Methods
231231

232+
<a name="method-copy-within"></a>
233+
234+
#### TypedArrayFE.prototype.copyWithin( target, start\[, end] )
235+
236+
Copies a sequence of elements within the array starting at `start` and ending at `end` (non-inclusive) to the position starting at `target`.
237+
238+
```javascript
239+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
240+
241+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
242+
243+
arr.copyWithin( 0, 3 );
244+
245+
var out = arr.get( 0 );
246+
// returns 4.0
247+
248+
out = arr.get( 1 );
249+
// returns 5.0
250+
```
251+
252+
232253
<a name="static-method-from"></a>
233254

234255
#### TypedArrayFE.from( endianness, src\[, map\[, thisArg]] )

0 commit comments

Comments
 (0)