Constructeur Symbol()

Baseline Large disponibilité

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis septembre 2015.

Le constructeur Symbol() renvoie une valeur de type symbol. Ce n'est pas à proprement parler un constructeur, car il n'accepte pas la syntaxe new Symbol() et qu'il n'est pas prévu pour créer des sous-classes. On pourra l'utiliser comme valeur pour la clause extends d'une définition de classe, mais on ne pourra pas l'utiliser avec un appel super, cela entraînera une exception.

Dans cet article

Exemple interactif

const symbol1 = Symbol();
const symbol2 = Symbol(42);
const symbol3 = Symbol("foo");

console.log(typeof symbol1);
// Expected output: "symbol"

console.log(symbol2 === 42);
// Expected output: false

console.log(symbol3.toString());
// Expected output: "Symbol(foo)"

console.log(Symbol("foo") === Symbol("foo"));
// Expected output: false

Syntaxe

js
Symbol();
Symbol(description);

Paramètres

description Facultatif

Une chaîne de caractères qui décrit le symbole. Elle peut être utilisée pour le débogage mais ne permet pas d'accéder au symbole lui-même.

Exemples

Créer des symboles

Pour créer un nouveau symbole primitif, on écrit Symbol() en fournissant éventuellement une chaîne de caractères comme description :

js
let sym1 = Symbol();
let sym2 = Symbol("toto");
let sym3 = Symbol("toto");

Dans le code précédent, on crée trois nouveaux symboles. On notera que Symbol("toto") ne convertit pas la chaîne de caractères "toto" en un symbole. C'est bien un nouveau symbole qui est créé chaque fois :

Symbol("toto") === Symbol("toto"); // false

new Symbol(…)

La syntaxe qui suit, utilisant l'opérateur new, déclenchera une exception TypeError :

let sym = new Symbol(); // TypeError

Cela permet d'éviter aux développeuses et développeurs de créer un objet enveloppant une valeur symbole primitive plutôt qu'un nouveau symbole. Ce comportement se distingue des autres types de données primitifs pour lesquels c'est possible (par exemple new Boolean(), new String() et new Number()).

Si on souhaite vraiment envelopper un symbole dans une valeur objet, il faudra utiliser la fonction Object() :

js
let sym = Symbol("toto");
let symObj = Object(sym);
typeof sym; // => "symbol"
typeof symObj; // => "object"

Aider à améliorer MDN

Cette page vous a-t-elle été utile ?

Oui Non

Apprendre à contribuer

Cette page a été modifiée le 17 févr. 2025 par les contributeur·ice·s du MDN.

Voir cette page sur GitHub • Signaler un problème avec ce contenu

Objets natifs standards
Symbol
Constructeur
1. Constructeur Symbol()
Méthodes statiques
1. Symbol.for()
2. Symbol.keyFor()
Propriétés statiques
Méthodes d'instance
Propriétés d'instance
1. Symbol.prototype.description
Héritage
Object/Function
Méthodes statiques
Propriétés statiques
Méthodes d'instance
Propriétés d'instance
1. Object.prototype.__proto__
2. Object.prototype.constructor