TypedArray.prototype[@@iterator]()

The [@@iterator]() method of TypedArray instances implements the iterable protocol and allows typed arrays to be consumed by most syntaxes expecting iterables, such as the spread syntax and for...of loops. It returns an array iterator object that yields the value of each index in the typed array.

The initial value of this property is the same function object as the initial value of the TypedArray.prototype.values property.

Try it

Syntax

js
typedArray[Symbol.iterator]()

Parameters

None.

Return value

The same return value as TypedArray.prototype.values(): a new iterable iterator object that yields the value of each index in the typed array.

Examples

Iteration using for...of loop

Note that you seldom need to call this method directly. The existence of the @@iterator method makes typed arrays iterable, and iterating syntaxes like the for...of loop automatically call this method to obtain the iterator to loop over.

js
const arr = new Uint8Array([10, 20, 30, 40, 50]);
for (const n of arr) {
  console.log(n);
}

Manually hand-rolling the iterator

You may still manually call the next() method of the returned iterator object to achieve maximum control over the iteration process.

js
const arr = new Uint8Array([10, 20, 30, 40, 50]);
const arrIter = arr[Symbol.iterator]();
console.log(arrIter.next().value); // 10
console.log(arrIter.next().value); // 20
console.log(arrIter.next().value); // 30
console.log(arrIter.next().value); // 40
console.log(arrIter.next().value); // 50

Specifications

Specification
ECMAScript Language Specification
# sec-%typedarray%.prototype-@@iterator

Browser compatibility

BCD tables only load in the browser

See also