Skip to content

Commit 7b3e9d7

Browse files
docs: add documentaion for keys method
1 parent 49a9e59 commit 7b3e9d7

File tree

1 file changed

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

1 file changed

+22
-0
lines changed

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -543,6 +543,28 @@ var v = arr.get( 100 );
543543
// returns undefined
544544
```
545545

546+
<a name="method-keys"></a>
547+
548+
#### TypedArrayFE.prototype.keys()
549+
550+
Returns an iterator for iterating over each index key in a typed array.
551+
552+
```javascript
553+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
554+
555+
var arr = new Float64ArrayFE( 'little-endian', 2 );
556+
var iter = arr.keys();
557+
558+
var v = iter.next().value;
559+
// returns 0
560+
561+
v = iter.next().value;
562+
// returns 1
563+
564+
var bool = iter.next().done;
565+
// returns true
566+
```
567+
546568
<a name="method-index-of"></a>
547569

548570
#### TypedArrayFE.prototype.indexOf( searchElement\[, fromIndex] )

0 commit comments

Comments
 (0)