Difference between iterator and generator in for of loop in JavaScript

Question

Lets have an iterator and a generator created to working similarly.

What is the reason they behave differently in for of loop if it contains break or return statement?

The generator is finished while the iterator still goes after the end of the loop.

function *createGenerator() { 
  for ( let i=0; i<5; i++ ) {
    yield i;
  }
}

function createIterator() {
  const arr = [1, 2, 3, 4, 5];
  return arr[ Symbol.iterator ]();
}

function runForOfLoopOn( iterable ) {
  for ( const item of iterable ) {
    if ( item == 2 ) { 
      break;
    }
  }
}

const iterator = createIterator();
const generator = createGenerator();

runForOfLoopOn( iterator );
runForOfLoopOn( generator );

console.log( 'Iterator is done:', iterator.next().done );
console.log( 'Generator is done:', generator.next().done );

Bergi · Accepted Answer · 2017-03-15 18:37:59Z

2

What happens when a for of loop contains a break or return statement?

When the body of the loop completes abruptly (with a throw or return statement) or is broken out of, the IteratorClose operation will be called. This which basically amounts to invoking the iterator's .return() method with no arguments if the iterator object has such a method.

What is the reason an iterator and a generator behave differently?

That only the generator has such a return() method. The ArrayIterator you created does not have such a method as there is nothing it would need to do. The primary purpose of the return() method is to release resources, e.g. by triggering finally clauses in a generator function, but array iterators don't use any. It could clear its reference to the iterated array (which would be "closing" the iterator), but this was deemed unnecessary as array iterators are typically garbage-collected right away.

answered Mar 15, 2017 at 18:37

Bergi

671k162 gold badges1k silver badges1.5k bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Maciej Bukowski Over a year ago

Thank you very much. Didn't expect such a good answer so quickly :) I came across the docs at the developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/… and even didn't find anything about the return method in iterators. Now, thanks to you I'll know it :)

Collectives™ on Stack Overflow

Difference between iterator and generator in for of loop in JavaScript

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related