Generator

Constructeur

Il n'existe aucune entit JavaScript qui corresponde au constructeur Generator. Les instances de Generator doivent tre retournes par des fonctions gnratrices :

function* generator() {
  yield 1;
  yield 2;
  yield 3;
}

const gen = generator(); // "Generator { }"

console.log(gen.next().value); // 1
console.log(gen.next().value); // 2
console.log(gen.next().value); // 3

Il existe seulement un objet cach qui est l'objet prototype partag par tous les objets crs par les fonctions gnratrices. Cet objet est souvent prsent comme Generator.prototype pour lui donner l'apparence d'une classe, mais il devrait plus justement tre appel GeneratorFunction.prototype.prototype, car GeneratorFunction est une entit JavaScript relle. Pour comprendre la chane de prototypes des instances de Generator, voir GeneratorFunction.prototype.prototype.

Proprits d'instance

Ces proprits sont dfinies sur Generator.prototype et partages par toutes les instances de Generator.

Generator.prototype.constructor

La fonction constructeur qui a cr l'objet instance. Pour les instances de Generator, la valeur initiale est GeneratorFunction.prototype.

Note : Les objets Generator ne conservent pas de rfrence la fonction gnratrice qui les a crs.

Generator.prototype[Symbol.toStringTag]

La valeur initiale de la proprit [Symbol.toStringTag] est la chane de caractres "Generator". Cette proprit est utilise dans Object.prototype.toString().

Mthodes d'instance

Hrite galement des mthodes d'instance de son parent Iterator.

Generator.prototype.next()

Retourne une valeur produite par l'expression yield.

Generator.prototype.return()

Agit comme si une instruction return tait insre dans le corps du gnrateur la position actuelle de suspension, ce qui termine le gnrateur et lui permet d'effectuer toute tche de libration lorsqu'elle est combine avec un bloc try...finally.

Generator.prototype.throw()

Agit comme si une instruction throw tait insre dans le corps du gnrateur la position actuelle de suspension, ce qui informe le gnrateur d'une condition d'erreur et lui permet de grer l'erreur, ou d'effectuer une libration et de se clturer.

Exemple

Un itrateur infini

function* infinite() {
  let index = 0;

  while (true) {
    yield index++;
  }
}

const generator = infinite(); // "Generator { }"

console.log(generator.next().value); // 0
console.log(generator.next().value); // 1
console.log(generator.next().value); // 2
// 

Spcifications

Compatibilit des navigateurs

Voir aussi

• La dclaration function*
• L'expression function*
• L'objet GeneratorFunction
• Les protocoles d'itration