Set.prototype[@@iterator]()

The [@@iterator]() method of Set instances implements the iterable protocol and allows sets to be consumed by most syntaxes expecting iterables, such as the spread syntax and for...of loops. It returns an set iterator object that yields the values of the set in insertion order.

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

Try it

Syntax

set[Symbol.iterator]()

Return value

The same return value as Set.prototype.values(): a new iterable iterator object that yields the values of the set.

Examples

Iteration using for...of loop

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

const mySet = new Set();
mySet.add("0");
mySet.add(1);
mySet.add({});

for (const v of mySet) {
  console.log(v);
}

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.

const mySet = new Set();
mySet.add("0");
mySet.add(1);
mySet.add({});

const setIter = mySet[Symbol.iterator]();

console.log(setIter.next().value); // "0"
console.log(setIter.next().value); // 1
console.log(setIter.next().value); // Object

Specifications

Specification
ECMAScript Language Specification
# sec-set.prototype-@@iterator

Browser compatibility

BCD tables only load in the browser

See also