Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

Déclaration de fonction génératrice et méthode génératrice

Les deux formes définissent des fonctions génératrices synchrones. La déclaration lie un nom dans sa portée, tandis que la méthode appartient à un objet ou à une classe.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

function* sequence(start) { yield start; }
const object = { *values() { yield this.start; } };
class Series { *values() { yield this.start; } }

Une déclaration comme function* sequence(start) { ... } lie le nom sequence dans sa portée. La forme *values() { ... } définit une méthode dans un objet ou une classe : l’astérisque précède le nom de la méthode et le mot-clé function est absent. Lors de l’appel counter.values(), this vaut counter dans la méthode.

Chaque appel renvoie un nouveau générateur synchrone, à la fois itérateur et itérable. Les instructions du corps ne s’exécutent qu’au premier appel à next(). yield value suspend l’exécution, conserve l’état local et produit un résultat de la forme { value, done: false }. L’appel suivant à next() reprend l’exécution. Utiliser new avec l’une ou l’autre fonction déclenche une TypeError.

Si next() atteint return value, son résultat est { value, done: true }. Une boucle for...of et la syntaxe de décomposition ... récupèrent les valeurs produites par yield, sans inclure la valeur de retour finale. Une fois le générateur terminé, les appels suivants à next() renvoient { value: undefined, done: true }. Pour repartir du début, rappelez la fonction ou la méthode.

Exemples

{
  function* sequence(start) {
    yield start;
    return start + 1;
  }

  const counter = {
    start: 7,
    *values() {
      yield this.start;
    },
  };

  const steps = sequence(3);
  for (let i = 0; i < 3; i++) {
    const { value, done } = steps.next();
    console.log(`${value} ${done}`);
  }
  console.log(JSON.stringify([...counter.values()]));
}

Résultat

3 false
4 true
undefined true
[7]

Les appels à `next()` montrent la valeur `3` produite par `yield`, la valeur `4` renvoyée par `return`, puis l’état du générateur épuisé. La décomposition du générateur issu de `counter.values()` donne `[7]`, car la méthode lit `counter.start` via `this`.

Leçons associées

  • JavaScript · Leçon 8 · Avancé · Version : 4

Sources