Baseline Widely available
La palabra clave yield
se usa para pausar y reanudar una función generadora (function*
o función generadora heredada
).
function* foo(index) {
while (index < 2) {
yield index;
index++;
}
}
const iterator = foo(0);
console.log(iterator.next().value);
// Expected output: 0
console.log(iterator.next().value);
// Expected output: 1
Sintaxis
[rv] = yield [expression]
expression
Opcional
Define el valor que se devolverá desde la función generadora a través del protocolo iterador
. Si se omite, devuelve undefined
en su lugar.
rv
Opcional
Recupera el valor opcional pasado al método next()
del generador para reanudar su ejecución.
La palabra clave yield
detiene la ejecución de la función del generador y el valor de la expresión que sigue a la palabra clave yield
se devuelve al llamador del generador. Se puede considerar como una versión basada en un generador de la palabra clave return
.
yield
solo se puede llamar directamente desde la función generadora que la contiene. No se puede llamar desde funciones anidadas o retrollamadas.
La palabra clave yield
hace que la llamada al método next()
del generador devuelva un objeto IteratorResult
con dos propiedades: value
y done
. La propiedad value
es el resultado de evaluar la expresión yield
, y done
es false
, lo cual indica que la función generadora no se ha completado completamente.
Una vez en pausa en una expresión yield
, la ejecución del código del generador permanece en pausa hasta que se llama al método next()
del generador. Cada vez que se llama al método next()
del generador, el generador reanuda la ejecución y se ejecuta hasta que alcanza uno de los siguientes:
yield
, el cual hace que el generador vuelva a pausar y devuelva el nuevo valor del generador. La próxima vez que se llame a next()
, la ejecución se reanudará con la instrucción inmediatamente después de yield
.throw
se usa para lanzar una excepción desde el generador. Esta detiene la ejecución del generador por completo y la ejecución se reanuda en el llamador (como suele ser el caso cuando se lanza una excepción).IteratorResult
al llamador en el que el value
es undefined
y done
es true
.return
. En este caso, la ejecución del generador finaliza y se devuelve un IteratorResult
al llamador en el que el value
es el valor especificado por la instrucción return
y done
es true
.Si se pasa un valor opcional al método next()
del generador, ese valor se convierte en el valor devuelto por la operación yield
actual del generador.
Entre la ruta del código del generador, sus operadores yield
y la capacidad de especificar un nuevo valor inicial pasándolo a Generator.prototype.next()
, los generadores ofrecen enorme poder y control.
Advertencia: Desafortunadamente, next()
es asimétrico, pero eso no se puede evitar: siempre envÃa un valor al yield
actualmente suspendido, pero devuelve el operando del siguiente yield
.
yield
El siguiente código es la declaración de una función generadora de ejemplo.
function* countAppleSales() {
let saleList = [3, 7, 5];
for (let i = 0; i < saleList.length; i++) {
yield saleList[i];
}
}
Una vez que se define una función generadora, se puede usar construyendo un iterador como el siguiente.
let appleStore = countAppleSales(); // Generator { }
console.log(appleStore.next()); // { value: 3, done: false }
console.log(appleStore.next()); // { value: 7, done: false }
console.log(appleStore.next()); // { value: 5, done: false }
console.log(appleStore.next()); // { value: undefined, done: true }
También puedes enviar un valor con next(value)
al generador. 'step
' se evalúa como un valor de retorno en esta sintaxis [rv] = yield [expression]
function* counter(value) {
let step;
while (true) {
step = yield ++value;
if (step) {
value += step;
}
}
}
const generatorFunc = counter(0);
console.log(generatorFunc.next().value); // 1
console.log(generatorFunc.next().value); // 2
console.log(generatorFunc.next().value); // 3
console.log(generatorFunc.next(10).value); // 14
console.log(generatorFunc.next().value); // 15
console.log(generatorFunc.next(10).value); // 26
Especificaciones Compatibilidad con navegadores Ve también
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4