CKTIS / JavaScript
Протокол на итератора: next(), return(), value и done
Проверявай `done`, а не `value`, за да разпознаеш края на обхождането. Научи как да прочетеш крайната стойност и кога `for...of` извиква незадължителния метод `return()`.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
const iterator = iterable[Symbol.iterator]();
const result = iterator.next();
// result.done: completion flag; result.value: element or completion value
// When stopping early during manual iteration, call the optional method if callable:
if (typeof iterator.return === "function") {
iterator.return();
}Синхронният итератор е обект с метод next(), който връща обект с резултат (IteratorResult). Итерируемият обект има метод [Symbol.iterator](), който връща итератор. Самото наличие на next() не прави обекта итерируем; обектът генератор изпълнява и двете роли. for...of получава итератора и извиква next() без аргументи. Значението на евентуален аргумент зависи от реализацията на итератора.
При done: false свойството value съдържа елемент, дори ако стойността му е undefined. done: true означава край на обхождането; тогава value може да съдържа крайна стойност, която for...of не подава на тялото на цикъла. Липсващо done се приема за false; при проверката for...of преобразува свойството в булева стойност. След изчерпване на итератора следващите извиквания на next() би трябвало пак да дават done: true, но езикът не налага това.
Незадължителният метод return(value) показва, че извикващият прекратява обхождането, и дава възможност на итератора да освободи ресурси. Резултатът обикновено съдържа done: true и подадения аргумент като value, но генератор може да върне done: false, ако изпълни yield в блок finally. При предсрочно излизане чрез break или поради изключение в тялото на цикъла for...of извиква return() без аргументи, ако методът е наличен, и пренебрегва done и value на резултата. Не го извиква при нормално изчерпване или ако самият next() хвърли изключение.
Ръчните извиквания на next() не затварят итератора автоматично. Ако спреш предсрочно, извикай return(), стига да е функция. for...of хвърля TypeError, ако next() или извикването на return() при затваряне не върне обект. Ако затварянето е предизвикано от изключение в тялото на цикъла, първоначалното изключение има предимство.
Примери
{
function* sequence() {
try {
yield undefined;
return "end";
} finally {
console.log("cleanup");
}
}
function show(label, { done, value }) {
console.log(`${label}: done=${done}, value=${value}`);
}
const full = sequence();
show("next", full.next());
show("next", full.next());
show("next", full.next());
for (const value of sequence()) {
console.log(`loop: ${value}`);
break;
}
const manual = sequence();
manual.next();
show("return", manual.return("stopped"));
}Резултат
next: done=false, value=undefined cleanup next: done=true, value=end next: done=true, value=undefined loop: undefined cleanup cleanup return: done=true, value=stopped
Три отделни генератора показват нормално изчерпване с крайна стойност `end`, автоматично затваряне при `break` и изрично извикване на `return("stopped")`. Всеки стартиран генератор извежда `cleanup` в своя блок `finally`.
Свързани уроци
- JavaScript · Урок 8 · Напреднало · Версия: 4