wiki/content/20201014092846-javascript_iterator.md

date	id	title
2020-10-14	9f77a5b0-a06d-46d0-828e-d6c5fe33111d	JavaScript Iterator

Introduction

An iterator is a pointer for traversing the elements of a data structure.

Examples

Syntax

const iterable = ["a", "b"];
const iterator = iterable[Symbol.iterator]();

console.log(iterator.next()); // { value: 'a', done: false }
console.log(iterator.next()); // { value: 'b', done: false }
console.log(iterator.next()); // { value: undefined, done: true }

TypeScript Interfaces

Expressed as interfaces in TypeScript notation:

interface Iterable {
    [Symbol.iterator]() : Iterator;
}
interface Iterator {
    next() : IteratorResult;
}
interface IteratorResult {
    value: any;
    done: boolean;
}