L'opérateur get

La syntaxe get permet de lier une propriété d'un objet à une fonction qui sera appelée lorsqu'on accédera à la propriété.

Syntaxe

{get prop() { ... } }
{get [expression]() { ... } }

Paramètres

prop

Le nom de la propriété à lier à la fonction.

expression

Avec ECMAScript 6, il est également possible d'utiliser des expressions renvoyant un nom de propriété calculé pour le lier à une fonction.

Description

Il est parfois utile de créer une propriété qui renvoie une valeur dynamique calculée, ou de ne pas avoir recours à l'appel explicite d'une méthode pour renvoyer le statut d'une variable interne. En JavaScript, il est possible de faire cela en utilisant un accesseur. Il n'est pas possible d'avoir simultanément un accesseur  assimilé à une propriété et d'avoir cette propriété initialisée à une valeur, mais il est possible d'utiliser un accesseur et un mutateur pour créer une sorte de pseudo-propriété.

On notera que l'opérateur get :

• peut être identifié par un nombre ou une chaîne de caractères
• ne doit pas posséder de paramètre (lire la page Changement ES5 : les fonctions d'accession et de mutation littérales doivent avoir maintenant zéro ou un paramètre. (en anglais) pour plus d'informations)
• ne doit pas apparaître dans un littéral objet avec un autre get ou une autre propriété avec le même identifiant (les codes suivants : { get x() { }, get x() { } } et { x: ..., get x() { } } sont interdits).

Un accesseur peut être supprimé grâce à l'opérateur delete.

Exemples

Définir un accesseur avec l'opérateur get

Ce code va créer une pseudo-propriété dernier de l'objet o qui va retourner la dernière entrée du tableau o.journal :

var o = {
  get dernier() {
    if (this.journal.length > 0) {
      return this.journal[this.journal.length - 1];
    }
    else {
      return null;
    }
  },
  journal: []
}

Notez qu'essayer d'assigner à dernier une valeur ne le modifiera pas.

Supprimer un accesseur avec l'opérateur delete

delete o.dernier;

Définir un accesseur sur des objets existants grâce à defineProperty

Afin d'ajouter un accesseur à un objet qui existe déjà, on peut utiliser la méthode Object.defineProperty().

var o = { a:0 }

Object.defineProperty(o, "b", { get: function () { return this.a + 1; } });

console.log(o.b) // Utilise l'accesseur qui génère a + 1 (qui correspond à 1)

Utiliser un nom de propriété calculé

var expr = "toto";

var obj = {
  get [expr]() { return "truc"; }
};

console.log(obj.toto); // "truc"

Spécifications

Compatibilité des navigateurs

Voir aussi

• set
• delete
• Object.defineProperty()
• __defineGetter__
• __defineSetter__
• Définir des accesseurs et mutateurs, un chapitre du Guide JavaScript