L'oprateur set

Exemple interactif

const language = {
  set current(name) {
    this.log.push(name);
  },
  log: [],
};

language.current = "EN";
language.current = "FA";

console.log(language.log);
// Expected output: Array ["EN", "FA"]

Syntaxe

{set prop(val) { . . .}}
{set [expression](val) { . . .}}

Paramtres

prop

Le nom de la proprit lier la fonction.

val

Un alias pour la variable qui contient la valeur qu'on souhaiterait affecter prop.

expression

Avec ECMAScript 2015, il est galement possible d'utiliser des expressions pour utiliser un nom de proprit calcul lier la fonction.

Description

En JavaScript, un mutateur (ou setter en anglais) peut tre utiis afin d'excuter une fonction chaque fois qu'on souhaite modifier la valeur d'une proprit donne. La plupart du temps, les mutateurs sont utiliss avec les accesseurs (getters) afin de crer une pseudo-proprit. Il n'est pas possible d'avoir la fois un mutateur et une valeur donne pour une mme proprit.

On notera que set :

• peut avoir un identifiant qui est soit un nombre soit une chane de caractres
• doit avoir exactement un paramtre (voir l'article Incompatible ES5 change: literal getter and setter functions must now have exactly zero or one arguments (en anglais) pour plus d'informations)
• ne doit pas apparatre dans un littral objet qui possde un autre set ou une autre proprit avec la mme cl : ( { set x(v) { }, set x(v) { } } et { x: ..., set x(v) { } } seront interdits)

On peut retirer un mutateur d'un objet grce l'oprateur delete.

Exemples

Dfinir un mutateur sur de nouveaux objets avec un littral objet

Dans l'exemple qui suit, on dfinit une pseudo-proprit courant pour un objet o qui, lorsqu'elle recevra une valeur, mettra jour la proprit log avec la valeur reue :

var o = {
  set courant(str) {
    this.log[this.log.length] = str;
  },
  log: [],
};

On notera que courant n'est pas dfini. Toute tentative pour y accder renverra undefined.

Supprimer un mutateur grce l'oprateur delete

Si on souhaite retirer un mutateur, on peut simplement utiliser l'oprateur delete :

delete o.courant;

Dfinir un mutateur sur un objet existant avec defineProperty

On peut galement ajouter un mutateur sur un objet d'ores et dj cr. Pour cela, on utilisera la mthode Object.defineProperty().

var o = { a: 0 };

Object.defineProperty(o, "b", {
  set: function (x) {
    this.a = x / 2;
  },
});

o.b = 10; // On utilise le setter, qui affecte 10 / 2 (5)  'a'
console.log(o.a); // 5

Utiliser un nom de proprit calcul

var expr = "toto";

var obj = {
  bidule: "truc",
  set [expr](v) {
    this.bidule = v;
  },
};

console.log(obj.bidule); // "truc"
obj.toto = "bidule"; // le mutateur est utilis
console.log(obj.bidule); // "bidule"

Spcifications

Compatibilit des navigateurs

Voir aussi

• get
• delete
• Object.defineProperty()
• Object.prototype.__defineGetter__()
• Object.prototype.__defineSetter__()
• Dfinir des accesseurs et des mutateurs, dans le Guide JavaScript