Собственные итераторы

Принципы

• Реализуйте метод [Symbol.iterator], возвращающий объект с next, чтобы сделать структуру итерируемой.
• Метод next должен возвращать объект { value, done }; когда done: true, итерация завершается.
• Итераторы позволяют использовать for...of, оператор распространения и другие конструкции, ожидающие итерируемый объект.

Пример

function range(start: number, end: number, step = 1) {
  return {
    [Symbol.iterator]() {
      return this;
    },
    next() {
      if (start < end) {
        start = start + step;
        return { value: start, done: false };
      }
      return { done: true, value: end };
    },
  };
}

for (const n of range(0, 10, 2)) {
  console.log(n);
}

Практика

• Следите за неизменяемостью исходных аргументов: лучше хранить внутренний счётчик, чем мутировать start.
• Возвращайте this из [Symbol.iterator], если сам объект является итератором; иначе создайте отдельный итератор.
• Для бесконечных последовательностей помните о защите от бесконечного цикла в потребителях.