arguments[Symbol.iterator]()

{{jsSidebar("Functions")}}

The [Symbol.iterator]() method of {{jsxref("Functions/arguments", "arguments")}} objects implements the iterable protocol and allows arguments objects to be consumed by most syntaxes expecting iterables, such as the spread syntax and {{jsxref("Statements/for...of", "for...of")}} loops. It returns an array iterator object that yields the value of each index in the arguments object.

The initial value of this property is the same function object as the initial value of the {{jsxref("Array.prototype.values")}} property (and also the same as Array.prototype[Symbol.iterator]()).

Syntax

arguments[Symbol.iterator]()

Parameters

None.

Return value

The same return value as {{jsxref("Array.prototype.values()")}} : a new iterable iterator object that yields the value of each index in the arguments object.

Examples

Iteration using for…of loop

Note that you seldom need to call this method directly. The existence of the [Symbol.iterator]() method makes arguments objects iterable, and iterating syntaxes like the for...of loop automatically call this method to obtain the iterator to loop over.

function f() {
  for (const letter of arguments) {
    console.log(letter);
  }
}
f("w", "y", "k", "o", "p");

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.

function f() {
  const argsIter = arguments[Symbol.iterator]();
  console.log(argsIter.next().value); // w
  console.log(argsIter.next().value); // y
  console.log(argsIter.next().value); // k
  console.log(argsIter.next().value); // o
  console.log(argsIter.next().value); // p
}
f("w", "y", "k", "o", "p");

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

docs.rodeo

MDN Web Docs mirror