yield
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.
Le mot-clé yield
est utilisé pour suspendre et reprendre une fonction génératrice (function*
ou une fonction génératrice historique).
Exemple interactif
Syntaxe
[rv] = yield[expression];
expression
-
Définit la valeur à retourner depuis la fonction génératrice via le protocole itérateur. Si omise,
undefined
sera retournée à la place. rv
-
Retourne la valeur optionnelle passée à la méthode
next()
pour reprendre son exécution.
Description
Le mot-clé yield
suspend une fonction génératrice et la valeur de l'expression suivant le mot-clé yield
est retournée à l'appelant du générateur. Il peut être vu comme une version générateur du mot-clé return
.
Le mot-clé yield
ne peut être appelé qu'à partir de la fonction génératrice qui le contient. Il ne peut pas être utilisé depuis des fonctions imbriquées ou avec des callbacks.
Le mot-clé yield
retourne en fait un objet IteratorResult
ayant deux propriétés, value
et done.
La propriété value
est le résultat de l'évaluation de l'expression yield
, et done
est false
, indiquant que la fonction génératrice n'est pas complètement terminée.
Une fois suspendue sur une expression yield
, l'exécution du code du générateur reste suspendue jusqu'à ce que la méthode next()
du générateur soit appelée. Chaque fois que la méthode next()
du générateur est appelée, le générateur reprend l'exécution et s'exécute jusqu'à ce qu'elle atteigne l'une des situations suivantes :
- un
yield
, ce qui provoque une nouvelle pause du générateur et retourne la nouvelle valeur du générateur ; la prochaine fois quenext()
sera appelé, l'exécution reprendra à l'instruction immédiatement après leyield
; throw
est utilisé pour déclencher une exception depuis le générateur ; cela arrête entièrement l'exécution du générateur et l'exécution reprend dans l'appelant, comme c'est normalement le cas lorsqu'une exception est déclenchée ;- la fin de la fonction génératrice est atteinte ; dans ce cas, l'exécution du générateur se termine et un
IteratorResult
est retourné à l'appelant, dans lequel la valeur estundefined
etdone
esttrue
; - une instruction
return
est atteinte ; dans ce cas, l'exécution du générateur se termine et unIteratorResult
est retourné à l'appelant dans lequel lavalue
est la valeur spécifiée par l'instructionreturn
etdone
vauttrue
.
Si une valeur optionnelle est passée à la méthode next()
du générateur, cette valeur devient la valeur retournée par l'opération yield
en cours du générateur.
Entre le chemin de code du générateur, ses opérateurs yield
, et la possibilité de spécifier une nouvelle valeur de départ en la passant à Generator.prototype.next()
, les générateurs offrent énormément de puissance et de contrôle.
Exemples
Le code suivant est la déclaration d'un exemple de fonction génératrice :
function* compteVentesPommes() {
var listeVentes = [3, 7, 5];
for (var i = 0; i < listeVentes.length; i++) {
yield listeVentes[i];
}
}
Une fois qu'une fonction génératrice est définie, elle peut être utilisée en construisant un itérateur comme indiqué.
var magasinPommes = compteVentesPommes(); // Générateur { }
console.log(magasinPommes.next()); // { value: 3, done: false }
console.log(magasinPommes.next()); // { value: 7, done: false }
console.log(magasinPommes.next()); // { value: 5, done: false }
console.log(magasinPommes.next()); // { value: undefined, done: true }
Spécifications
Specification |
---|
ECMAScript Language Specification # prod-YieldExpression |
Compatibilité des navigateurs
BCD tables only load in the browser
Voir aussi
- Le protocole itérateur
- L'instruction
function*
- L'expression
function*
- L'opérateur
yield*