Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

Définir un accesseur de lecture dans un littéral d’objet

Dans un littéral d’objet, `get` associe une propriété à une fonction exécutée lors de la lecture, ce qui permet de renvoyer une valeur calculée à partir de l’état courant de l’objet.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

const obj = { get name() { /* body */ } };
const computed = { get [expression]() { /* body */ } };

Dans un littéral d’objet, get name() { … } crée une propriété d’accès propre à l’objet, énumérable et configurable. get [expression]() { … } permet d’utiliser une clé calculée. La liste de paramètres doit être vide, sinon la définition provoque une erreur SyntaxError.

Lire obj.name appelle l’accesseur sans argument et renvoie son résultat. Lors de cette lecture, this vaut obj, même si l’accesseur est hérité. Le résultat n’est pas mis en cache automatiquement. À l’inverse, name() { … } définit une méthode ordinaire stockée comme valeur d’une propriété de données ; lire la propriété n’appelle pas la méthode.

Un descripteur d’accès utilise get et set, et non value et writable. Object.getOwnPropertyDescriptor() permet d’inspecter une propriété propre sans appeler son accesseur de lecture. Sans accesseur d’écriture correspondant, une affectation ordinaire à cette propriété est ignorée hors mode strict et lève une erreur TypeError en mode strict.

Pour ajouter un accesseur de lecture à un objet existant, utilise Object.defineProperty() avec un descripteur contenant get. Pour une nouvelle propriété, enumerable et configurable valent alors false par défaut si on les omet, contrairement au littéral d’objet. Un accesseur de lecture public non statique d’une classe se trouve sur le prototype de la classe et n’est pas énumérable.

Exemples

{
  const item = {
    price: 10,
    quantity: 2,
    get total() {
      return this.price * this.quantity;
    },
  };

  console.log(item.total);
  item.quantity = 3;
  console.log(item.total);

  const descriptor = Object.getOwnPropertyDescriptor(item, "total");
  console.log(typeof descriptor.get);
  console.log(descriptor.enumerable);
  console.log(descriptor.configurable);
}

Résultat

20
30
function
true
true

La première lecture de `item.total` renvoie `20` ; après modification de `quantity`, la deuxième renvoie `30`. Les trois dernières lignes montrent que le descripteur contient une fonction de lecture et que la propriété est énumérable et configurable.

Leçons associées

  • JavaScript · Leçon 19 · Avancé · Version : 4

Sources