Статья про "Итератор". Изменить пример добавления `Symbol.iterator` в произвольный объект

[mrswylet]

Ссылка на статью

https://doka.guide/js/iterator/

Описание

В статье есть следующий пример, показывающий, как сделать объект итерируемым.

person[Symbol.iterator] = function () {
  const properties = Object.keys(this)
  let count = 0

  return {
    next() {
      if (count < properties.length) {
        const key = properties[count]
        let result = { done: false, value: person[key] }
        count++
        return result
      } else {
        return { done: true }
      }
    }
  }
}

Предлагаю немного изменить его.

1. Запомнить через замыкание this в начале функции, например _this.
2. При получении значения value через метод next получать значение из _this, а не через объект person.

Зачем это?

Это уменьшит вероятность случайных ошибок при копировании примера.

Итоговый вариант

person[Symbol.iterator] = function () {
  const _this = this;
  const properties = Object.keys(this)
  let count = 0

  return {
    next() {
      if (count < properties.length) {
        const key = properties[count]
        let result = { done: false, value: _this[key] }
        count++
        return result
      } else {
        return { done: true }
      }
    }
  }
}

Готов сделать PR, если авторы согласны с правкой.

Пруфы

No response

[vitya-ne]

Привет, спасибо за внимательность.
А в каком случае может произойти случайная ошибка при копировании примера ?
Было бы здорово дополнить пример небольшой вставкой с объяснением этих тонкостей

[mrswylet]

@vitya-ne

Пример того, как можно получить ошибку.

У читателя есть свой какой-либо объект, например:

export const subscription = {
  id: 'sub_01HZX3Q1ABCD',
  planName: 'Pro Plan',
  status: 'active',
  price: 299.9,
  billingInterval: 'month',
  intervalCount: 1,
};

Он прочитал статью, скопировал пример и получил следующий код:

subscription[Symbol.iterator] = function () {
  const properties = Object.keys(this)
  let count = 0

  return {
    next() {
      if (count < properties.length) {
        const key = properties[count]
        let result = { done: false, value: person[key] }
        count++
        return result
      } else {
        return { done: true }
      }
    }
  }
}

В консоли увидит ошибку, потому что у нет объекта person.

Я, конечно, понимаю, что:

• слепо копировать примеры из интернета нехорошо;
• это вопрос внимательности;
• а если ошибка и возникнет, время её исправления — 5 секунд.

Но всё же считаю, что если внести правку, читателям станет чуть удобнее.

[vitya-ne]

Будем рады увидеть пиар с исправлением примера и пояснением этих тонкостей