mozilla

Set

Cette fonction, proposition pour ECMAScript 6 (Harmony), est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.

L'objet Set (Ensemble en français) permet de stocker des valeurs uniques, de n'importe quel type, que ce soit des valeurs d'un type primitif ou des objets.

Syntaxe

 new Set([itérable]);

Paramètres

itérable
Paramètre optionnel. Si un objet itérable est donné comme argument, l'ensemble de ses éléments sera ajouté au nouvel objet Set. null sera traité comme undefined.

Description

Les objets Set sont des ensembles de valeurs. Il est possible d'itérer sur les éléments contenus dans l'objet Set dans leur ordre d'insertion. Une valeur donnée ne peut apparaître qu'une seule fois par Set.

Égalité des valeurs

Chaque valeur d'un Set doit être unique, il faut donc tester l'égalité des valeurs contenues. Cette égalité n'est pas la même que celle de l'opérateur ===. Notamment, pour les objets Set+0 (qui, selon l'égalité stricte, est égal à -0) et -0 sont des valeurs différentes. Cela a toutefois été changé avec la dernière version d'ECMAScript 6. À partir de Gecko 29.0 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26) (bug 952870) et avec une version nightly récente de Chrome, +0 et -0 sont considérés comme les mêmes valeurs pour Set. NaN et undefined peuvent être enregistrés dans un objet Set. NaN est considéré comme NaN (bien que NaN !== NaN).

Propriétés

Set.length
La valeur de la propriété length est 0.
get Set[@@species]
Le constructeur utilisé pour créer des objets dérivés.
Set.prototype
Représente le prototype du constructeur Set. Cela permet d'ajouter des propriétés à tous les objets Set.

Instances de Set

Toutes les instances de Set héritent de Set.prototype.

Propriétés

Set.prototype.constructor
Renvoie la fonction qui crée le prototype d'une instance. Par défaut, ce sera la fonction Set.
Set.prototype.size
Renvoie le nombre de valeurs contenues dans l'objet Set.

Méthodes

Set.prototype.add(valeur)
Ajoute un nouvel élément à l'objet Set avec la valeur donnée. La valeur de retour est l'objet Set.
Set.prototype.clear()
Retire tous les éléments de l'objet Set.
Set.prototype.delete(valeur)
Retire l'élément associé à la valeur et renvoie la valeur que Set.prototype.has(valeur) aurait renvoyé. Set.prototype.has(valeur) renverra false après la suppression.
Set.prototype.entries()
Renvoie un nouvel objet Iterator qui contient un tableau de [valeur, valeur] pour chaque élément de l'objet Set, dans l'ordre dans lequel les valeurs ont été insérées. On aura donc une structure semblable à un objet Map. Ici, chaque entrée aura la même valeur pour la clé et la valeur.
Set.prototype.forEach(fnCallback[, thisArg])
Appelle la fonction fnCallback pour chaque valeur présente dans l'objet Set, dans l'ordre dans lequel elles ont été insérées. Si un paramètre thisArg est fourni à forEach, il sera utilisé comme valeur de this pour chaque appel de la fonction de callback.
Set.prototype.has(valeur)
Renvoie un booléen qui indique si un des éléments de l'ensemble possède cette valeur.
Set.prototype.keys()
Cette fonction correspond à la fonction values() et renvoie un nouvel objet Iterator qui contient les valeurs correspondant à chaque élément de Set dans l'ordre dans lequel ils ont été insérés.
Set.prototype.values()
Renvoie un nouvel objet Iterator qui contient les valeurs pour chacun des éléments de l'objet Set, dans l'ordre dans lequel ils ont été insérés.
Set.prototype[@@iterator]()
Renvoie un nouvel objet Iterator qui contient les valeurs pour chaque élément de l'objet Set dans leur ordre d'insertion.

Exemples

Utiliser l'objet Set

var monSet = new Set();

monSet.add(1);
monSet.add(5);
monSet.add("du texte");

monSet.has(1); // true
monSet.has(3); // false, 3 n'a pas été ajouté à l'ensemble
monSet.has(5);              // true
monSet.has(Math.sqrt(25));  // true
monSet.has("Du Texte".toLowerCase()); // true

monSet.size; // 3

monSet.delete(5); // retire 5 du set
monSet.has(5);    // false, 5 a été retiré de l'ensemble

monSet.size; // 2, on a retiré une valeur de l'ensemble

Itérer sur des ensembles (Set)

// On itère sur les différents éléments de l'ensemble
// ici on affiche : 1, "du texte" 
for (let item of monSet) console.log(item);

// ici on affiche les clés de l'ensemble : 1, "du texte"  
for (let item of monSet.keys()) console.log(item);
 
// ici on affiche les valeurs de l'ensemble : 1, "du texte" 
for (let item of monSet.values()) console.log(item);

// ici on affiche les clés de l'ensemble : 1, "du texte" 
//(ici, les clés et les valeurs sont les mêmes)
for (let [clé, valeur] of monSet.entries()) console.log(clé);

// on convertit l'ensemble en un tableau Array grâce à une compréhension
var monTableau = [v for (v of monSet)]; // [1, "du texte"]
// Une autre méthode de conversion avec Array.from
var monTableau = Array.from(monSet);    // [1, "du texte"]

// Cela fonctionnera également dans un document HTML
monSet.add(document.body);
monSet.has(document.querySelector("body")); // true

// convertir un tableau (Array) en ensemble (Set) et vice versa
monSet2 = new Set([1,2,3,4]);
monSet2.size; // 4
[...monSet2]; // [1,2,3,4]

// L'intersection peut être calculée avec
var intersection = new Set([x for (x of set1) if (set2.has(x))]);

// On peut itérer sur les entrées d'un ensemble avec forEach
mySet.forEach(function(value) {
  console.log(value);
});

// 1
// 2
// 3
// 4

Les relations avec les objets Array

var monTableau = ["valeur1", "valeur2", "valeur3"];

// On peut utiliser le constructeur Set pour transformer un Array en Set
var monSet = new Set(monTableau);

monSet.has("value1"); // renvoie true

// Et utiliser l'opérateur de décomposition pour transformer un Set en Array.
console.log(uneval([...monSet])); // affichera la même chose que monTableau

Spécifications

Spécification Statut Commentaires
ECMAScript 6 (ECMA-262)
La définition de 'Set' dans cette spécification.
En cours de validation comme recommandation Définition initiale.

Compatibilité des navigateurs

Fonctionnalité Chrome Firefox (Gecko) Internet Explorer Opera Safari
Support simple

31 [1]
38

13 (13) 11 25 7.1
Argument du constructeur : new Set(iterable) 38 13 (13) Pas de support 25 Pas de support
Itérable 38 17 (17) Pas de support 25 7.1
Set.clear() 31 [1]
38
19 (19) 11 25 7.1
Set.keys(), Set.values(), Set.entries() 37 [1]
38
24 (24) Pas de support 25 7.1
Set.forEach() 36 [1]
38
25 (25) 11 25 7.1
Égalité de valeurs entre -0 et 0 34 [1]
38
29 (29) Pas de support 25 Pas de support
Argument du constructeur new Set(null) (Oui) 37 (37) ? ? ?
Correction (monkey-patching) de add() dans le constructeur (Oui) 37 (37) ? ? ?
Set[@@species] ? 41 (41) ? ? ?
Fonctionnalité Android Chrome pour Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Support simple Pas de support 31 [1]
38
13.0 (13) Pas de support Pas de support iOS 8
Argument du constructeur : new Set(iterable) Pas de support 38 13.0 (13) Pas de support Pas de support Pas de support
Itérable Pas de support Pas de support 17.0 (17) Pas de support Pas de support iOS 8
Set.clear() Pas de support 31 [1]
38
19.0 (19) Pas de support Pas de support iOS 8
Set.keys(), Set.values(), Set.entries() Pas de support 37 [1] 38 24.0 (24) Pas de support Pas de support iOS 8
Set.forEach() Pas de support 36 [1]
38
25.0 (25) Pas de support Pas de support iOS 8
Égalité de valeurs entre -0 et 0 Pas de support 34 [1]
38
29.0 (29) Pas de support Pas de support Pas de support
Argument du constructeur new Set(null) ? (Oui) 37.0 (37) ? ? ?
Correction (monkey-patching) de add() dans le constructeur ? (Oui) 37.0 (37) ? ? ?
Set[@@species] ? ? 41.0 (41) ? ? ?

[1] Cette fonctionnalité peut être activée grâce à une préférence. Dans chrome://flags, activer l'option « Activer la fonctionnalité expérimentale JavaScript ».

Voir aussi

Étiquettes et contributeurs liés au document

Contributeurs à cette page : SphinxKnight
Dernière mise à jour par : SphinxKnight,