aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/javascript/reference/global_objects/generator/index.md
blob: 7540ca763f042dd6b70f62378550dcafbc04135e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
---
title: Generator
slug: Web/JavaScript/Reference/Global_Objects/Generator
tags:
  - ECMAScript 2015
  - Generator
  - JavaScript
  - Reference
translation_of: Web/JavaScript/Reference/Global_Objects/Generator
original_slug: Web/JavaScript/Reference/Objets_globaux/Generator
---
{{JSRef}}

L'objet **`Generator`** est renvoyé par une {{jsxref("Instructions/function*","fonction génératrice","",1)}}, c'est à la fois [un itérateur](/fr/docs/Web/JavaScript/Reference/Les_protocoles_iteration#Le_protocole_%C2%AB_it%C3%A9rateur_%C2%BB) et [un itérable](/fr/docs/Web/JavaScript/Reference/Les_protocoles_iteration#Le_protocole_%C2%AB_it%C3%A9rable_%C2%BB).

## Syntaxe

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

    var g = gen(); // "Generator { }"

## Méthodes

- {{jsxref("Generator.prototype.next()")}}
  - : Renvoie une valeur générée par l'expression {{jsxref("Opérateurs/yield", "yield")}}.
- {{jsxref("Generator.prototype.return()")}}
  - : Renvoie la valeur donnée et termine le générateur.
- {{jsxref("Generator.prototype.throw()")}}
  - : Lève une exception dans un générateur. Cette opération termine le générateur, sauf si l'exception est interceptée dans le générateur.

## Exemple

### Un itérateur infini

```js
function* idMaker(){
    var index = 0;
    while(true)
        yield index++;
}

var gen = idMaker(); // "Generator { }"

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

## Générateurs historiques

Firefox (SpiderMonkey) implémente également une version antérieure pour les générateurs avec [JavaScript 1.7](/fr/docs/Web/JavaScript/New_in_JavaScript/1.7). Pour cette syntaxe, il n'y a pas besoin d'utiliser l'astérisque dans la déclaration de la fonction, il suffit d'utiliser le mot-clé `yield` dans le corps de la fonction. Les générateurs historiques sont une fonctionnalité dépréciée et seront supprimés à l'avenir ({{bug(1083482)}}), il est fortement déconseillé de les utiliser.

### Méthodes pour les générateurs historiques

- `Generator.prototype.next() `{{non-standard_inline}}
  - : Renvoie une valeur générée par l'expression {{jsxref("Opérateurs/yield", "yield")}}. Cette méthode correspond à `next()` pour les générateurs ES2015.
- `Generator.prototype.close()` {{non-standard_inline}}
  - : Clôture le générateur, tout appel ultérieur à `next()` renverra une exception {{jsxref("StopIteration")}}. Cela correspond à la méthode `return()` pour les générateurs ES2015.
- `Generator.prototype.send()` {{non-standard_inline}}
  - : Utilisée pour envoyer une valeur à un générateur. La valeur est renvoyée avec une expression {{jsxref("Opérateurs/yield", "yield")}} et renvoie une valeur générée par la prochaine expression {{jsxref("Opérateurs/yield", "yield")}}. `send(x)` correspond à `next(x)` pour les générateurs ES2015.
- **`Generator.`**`prototype.`**`throw()` **{{non-standard_inline}}
  - : Lève une exception au sein d'un générateur. Cela correspond à la méthode `throw()` pour les générateurs ES2015.

### Exemple utilisant un générateur historique

```js
function* fibonacci() {
  var a = yield 1;
  yield a * 2;
}

var it = fibonacci();
console.log(it);          // "Generator {  }"
console.log(it.next());   // 1
console.log(it.send(10)); // 20
console.log(it.close());  // undefined
console.log(it.next());   // throws StopIteration (le générateur est clôturé)
```

## Spécifications

| Spécification                                                                                | État                         | Commentaires         |
| -------------------------------------------------------------------------------------------- | ---------------------------- | -------------------- |
| {{SpecName('ES2015', '#sec-generator-objects', 'Generator objects')}} | {{Spec2('ES2015')}}     | Définition initiale. |
| {{SpecName('ESDraft', '#sec-generator-objects', 'Generator objects')}} | {{Spec2('ESDraft')}} |                      |

## Compatibilité des navigateurs

{{Compat("javascript.builtins.Generator")}}

## Voir aussi

### Générateurs historiques

- {{jsxref("Instructions/Fonction_génératrice_historique", "Fonction génératrice historique", "", 1)}}
- {{jsxref("Opérateurs/function*", "L'expression d'un générateur historique", "", 1)}}
- {{jsxref("StopIteration")}}
- [Le protocole itérateur historique](/fr/docs/Web/JavaScript/Guide/Le_protocole_itérateur_historique)

### Générateurs ES2015

- {{jsxref("Fonctions", "Fonctions", "", 1)}}
- {{jsxref("Instructions/function", "function")}}
- L'expression {{jsxref("L_opérateur_function", "function")}}
- {{jsxref("Function")}}
- {{jsxref("Instructions/function*", "function*")}}
- L'expression {{jsxref("Opérateurs/function*", "function*")}}
- {{jsxref("GeneratorFunction")}}
- [Le protocole Iterator](/fr/docs/Web/JavaScript/Guide/Le_protocole_iterator)