Comment puis-je garantir que la définition de mes enums ne change pas en JavaScript ?

Question

Est-ce que les objets suivants rempliraient toutes les caractéristiques que les enums ont en JavaScript ? Quelque chose comme :

my.namespace.ColorEnum = {
    RED : 0,
    GREEN : 1,
    BLUE : 2
}

// later on

if(currentColor == my.namespace.ColorEnum.RED) {
   // whatever
}

Ou y a-t-il un autre moyen de le faire ?

Answer 1

Depuis la version 1.8.5, il est possible de sceller et congeler l'objet donc définissez ce qui précède comme :

const DaysEnum = Object.freeze({"monday":1, "tuesday":2, "wednesday":3, ...})

ou

const DaysEnum = {"monday":1, "tuesday":2, "wednesday":3, ...}
Object.freeze(DaysEnum)

et voilà ! Les enums JS.

Cependant, cela ne vous empêche pas d'attribuer une valeur non désirée à une variable, ce qui est souvent le principal objectif des enums :

let day = DaysEnum.tuesday
day = 298832342 // goes through without any errors

Une façon de garantir un degré plus élevé de sécurité des types (avec des enums ou autres) est d'utiliser un outil tel que TypeScript ou Débit .

Les citations ne sont pas nécessaires mais je les ai gardées par souci de cohérence.

Answer 2

Ce n'est pas vraiment une réponse, mais je dirais que ça marche très bien, personnellement.

Cela dit, puisque les valeurs n'ont pas d'importance (vous avez utilisé 0, 1, 2), j'utiliserais une chaîne de caractères significative au cas où vous voudriez afficher la valeur actuelle.

Answer 3

UPDATE

Merci pour tous les votes positifs, mais je ne pense pas que ma réponse ci-dessous soit la meilleure façon d'écrire des enums en JavaScript. Voir mon article de blog pour plus de détails : Enums en JavaScript .

---

L'alerte du nom est déjà possible :

if (currentColor == my.namespace.ColorEnum.RED) {
   // alert name of currentColor (RED: 0)
   var col = my.namespace.ColorEnum;
   for (var name in col) {
     if (col[name] == col.RED)
       alert(name);
   }
}

Vous pouvez également faire des valeurs des objets, afin d'avoir le beurre et l'argent du beurre :

var SIZE = {
  SMALL : {value: 0, name: "Small", code: "S"}, 
  MEDIUM: {value: 1, name: "Medium", code: "M"}, 
  LARGE : {value: 2, name: "Large", code: "L"}
};

var currentSize = SIZE.MEDIUM;
if (currentSize == SIZE.MEDIUM) {
  // this alerts: "1: Medium"
  alert(currentSize.value + ": " + currentSize.name);
}

En JavaScript, comme il s'agit d'un langage dynamique, il est même possible d'ajouter ultérieurement des valeurs d'énumération à l'ensemble :

// Add EXTRALARGE size
SIZE.EXTRALARGE = {value: 3, name: "Extra Large", code: "XL"};

N'oubliez pas que les champs de l'enum (valeur, nom et code dans cet exemple) ne sont pas nécessaires au contrôle d'identité et ne sont là que par commodité. De même, le nom de la propriété size n'a pas besoin d'être codé en dur, mais peut être défini dynamiquement. Ainsi, si vous ne connaissez que le nom de la nouvelle valeur de votre enum, vous pouvez l'ajouter sans problème :

// Add 'Extra Large' size, only knowing it's name
var name = "Extra Large";
SIZE[name] = {value: -1, name: name, code: "?"};

Bien sûr, cela signifie que certaines hypothèses ne peuvent plus être faites (que la valeur représente l'ordre correct pour la taille par exemple).

Rappelez-vous, en JavaScript, un objet est comme un carte ou table de hachage . Un ensemble de paires nom-valeur. Vous pouvez les parcourir en boucle ou les manipuler d'une autre manière sans en savoir beaucoup à l'avance.

Exemple

for (var sz in SIZE) {
  // sz will be the names of the objects in SIZE, so
  // 'SMALL', 'MEDIUM', 'LARGE', 'EXTRALARGE'
  var size = SIZE[sz]; // Get the object mapped to the name in sz
  for (var prop in size) {
    // Get all the properties of the size object, iterates over
    // 'value', 'name' and 'code'. You can inspect everything this way.        
  }
} 

À propos, si les espaces de noms vous intéressent, vous pouvez jeter un coup d'œil à ma solution pour une gestion simple mais puissante des espaces de noms et des dépendances pour JavaScript : Packages JS

Answer 4

En résumé : Vous ne pouvez pas.

Vous pouvez faire semblant, mais vous n'aurez pas la sécurité du type. En général, cela se fait en créant un simple dictionnaire de valeurs de chaînes de caractères associées à des valeurs entières. Par exemple :

var DaysEnum = {"monday":1, "tuesday":2, "wednesday":3, ...}

Document.Write("Enumerant: " + DaysEnum.tuesday);

Le problème de cette approche ? Vous pouvez accidentellement redéfinir votre énumérateur, ou accidentellement avoir des valeurs d'énumérateur en double. Par exemple :

DaysEnum.monday = 4; // whoops, monday is now thursday, too

Modifier

Qu'en est-il de Object.freeze d'Artur Czajka ? Cela ne fonctionnerait-il pas pour vous empêcher de mettre le lundi au jeudi ? - Fry Quad

Absolument, Object.freeze réglerait totalement le problème dont je me suis plaint. Je voudrais rappeler à tout le monde que lorsque j'ai écrit ce qui précède, Object.freeze n'a pas vraiment existé.

Maintenant.... maintenant ça ouvre quelques très des possibilités intéressantes.

Edit 2
Voici une très bonne bibliothèque pour créer des enums.

http://www.2ality.com/2011/10/enums.html

Bien que cela ne corresponde probablement pas à toutes les utilisations valables des enums, cela va très loin.

Answer 5

Voici ce que nous voulons tous :

function Enum(constantsList) {
    for (var i in constantsList) {
        this[constantsList[i]] = i;
    }
}

Maintenant vous pouvez créer vos enums :

var YesNo = new Enum(['NO', 'YES']);
var Color = new Enum(['RED', 'GREEN', 'BLUE']);

En faisant cela, les constantes peuvent être accédées de la manière habituelle (OuiNon.OUI, Couleur.VERT) et elles obtiennent une valeur int séquentielle (NON = 0, OUI = 1 ; ROUGE = 0, VERT = 1, BLEU = 2).

Vous pouvez également ajouter des méthodes, en utilisant Enum.prototype :

Enum.prototype.values = function() {
    return this.allValues;
    /* for the above to work, you'd need to do
            this.allValues = constantsList at the constructor */
};

Edit - petite amélioration - maintenant avec varargs : (malheureusement cela ne fonctionne pas correctement sur IE :S... je devrais m'en tenir à la version précédente alors)

function Enum() {
    for (var i in arguments) {
        this[arguments[i]] = i;
    }
}

var YesNo = new Enum('NO', 'YES');
var Color = new Enum('RED', 'GREEN', 'BLUE');