Come enumerare a livello di codice un tipo di enumerazione?

91

Dire che ho un dattiloscritto enum, MyEnumcome segue:

enum MyEnum {
    First,
    Second,
    Third
}

Quale sarebbe il modo migliore in TypeScript 0.9.5 per produrre un array di enumvalori? Esempio:

var choices: MyEnum[]; // or Array<MyEnum>
choices = MyEnum.GetValues(); // plans for this?
choices = EnumEx.GetValues(MyEnum); // or, how to roll my own?
enums  typescript 
— David Cuccia
fonte

Risposte:

193

Questo è l'output JavaScript di quell'enumerazione:

var MyEnum;
(function (MyEnum) {
    MyEnum[MyEnum["First"] = 0] = "First";
    MyEnum[MyEnum["Second"] = 1] = "Second";
    MyEnum[MyEnum["Third"] = 2] = "Third";
})(MyEnum || (MyEnum = {}));

Che è un oggetto come questo:

{
    "0": "First",
    "1": "Second",
    "2": "Third",
    "First": 0,
    "Second": 1,
    "Third": 2
}

Enum membri con valori stringa

TypeScript 2.4 ha aggiunto la possibilità per le enumerazioni di avere eventualmente valori di membro enum di stringa. Quindi è possibile finire con un'enumerazione simile alla seguente:

enum MyEnum {
    First = "First",
    Second = 2,
    Other = "Second"
}

// compiles to
var MyEnum;
(function (MyEnum) {
    MyEnum["First"] = "First";
    MyEnum[MyEnum["Second"] = 2] = "Second";
    MyEnum["Other"] = "Second";
})(MyEnum || (MyEnum = {}));

Ottenere i nomi dei membri

Possiamo guardare l'esempio immediatamente sopra per cercare di capire come ottenere i membri enum:

{
    "2": "Second",
    "First": "First",
    "Second": 2,
    "Other": "Second"
}

Ecco cosa mi è venuto in mente:

const e = MyEnum as any;
const names = Object.keys(e).filter(k => 
    typeof e[k] === "number"
    || e[k] === k
    || e[e[k]]?.toString() !== k
);

Valori dei membri

Una volta che abbiamo i nomi, possiamo eseguire il loop su di essi per ottenere il valore corrispondente facendo:

const values = names.map(k => MyEnum[k]);

Classe di estensione

Penso che il modo migliore per farlo sia creare le proprie funzioni (es. EnumEx.getNames(MyEnum)). Non puoi aggiungere una funzione a un'enumerazione.

class EnumEx {
    private constructor() {
    }

    static getNamesAndValues(e: any) {
        return EnumEx.getNames(e).map(n => ({ name: n, value: e[n] as string | number }));
    }

    static getNames(e: any) {
        return Object.keys(e).filter(k => 
            typeof e[k] === "number"
            || e[k] === k
            || e[e[k]]?.toString() !== k
        );
    }

    static getValues(e: any) {
        return EnumEx.getNames(e).map(n => e[n] as string | number);
    }
}
— David Sherret
fonte
Curiosamente (perché molte persone hanno votato contro questa risposta), non riesco a farlo funzionare in TS Playground: shorturl.me/jJ8G2t Sto facendo qualcosa di sbagliato?
— Peter
1
@ Peter Ho aggiornato la risposta per includere informazioni sulle enumerazioni delle stringhe. Inoltre, ti consigliamo di utilizzare una for ofdichiarazione invece di unfor in
— David Sherret
24

Con TypeScript> = 2.4 puoi definire enumerazioni di stringa:

enum Color {
  RED = 'Red',
  ORANGE = 'Orange',
  YELLOW = 'Yellow',
  GREEN = 'Green',
  BLUE = 'Blue',
  INDIGO = 'Indigo',
  VIOLET = 'Violet'
}

Uscita JavaScript ES5:

var Color;
(function (Color) {
    Color["RED"] = "Red";
    Color["ORANGE"] = "Orange";
    Color["YELLOW"] = "Yellow";
    Color["GREEN"] = "Green";
    Color["BLUE"] = "Blue";
    Color["INDIGO"] = "Indigo";
    Color["VIOLET"] = "Violet";
})(Color || (Color = {}));

Che è un oggetto come questo:

const Color = {
  "RED": "Red",
  "ORANGE": "Orange",
  "YELLOW": "Yellow",
  "GREEN": "Green",
  "BLUE": "Blue",
  "INDIGO": "Indigo",
  "VIOLET": "Violet"
}

Quindi, nel caso di enumerazioni di stringhe, non è necessario filtrare le cose Object.keys(Color)e Object.values(Color)(*) sono sufficienti:

const colorKeys = Object.keys(Color) as (keyof typeof Color)[];
console.log('colorKeys =', colorKeys);
// ["RED", "ORANGE", "YELLOW", "GREEN", "BLUE", "INDIGO", "VIOLET"]

const colorValues = Object.values(Color);
console.log('colorValues =', colorValues);
// ["Red", "Orange", "Yellow", "Green", "Blue", "Indigo", "Violet"]

colorKeys.map(colorKey => {
  console.log(`color key = ${colorKey}, value = ${Color[colorKey]}`);
});
/*
color key = RED, value = Red
color key = ORANGE, value = Orange
color key = YELLOW, value = Yellow
color key = GREEN, value = Green
color key = BLUE, value = Blue
color key = INDIGO, value = Indigo
color key = VIOLET, value = Violet
*/

Vedi l' esempio in linea sul playground TypeScript

(*) Polyfill necessario per i vecchi browser, vedere https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Object/values#Browser_compatibility

— tanguy_k
fonte
Questo ha l'erroreElement implicitly has an 'any' type because expression of type 'string' can't be used to index type 'typeof Color'. No index signature with a parameter of type 'string' was found on type 'typeof Color'.
— Jonas
1
@ Jonas l'ho risolto con un cast:Object.keys(Color) as (keyof typeof Color)[]
— tanguy_k
9

Puoi aggiungere funzioni per ottenere i nomi e gli indici dell'enumerazione:

enum MyEnum {
  First,
  Second,
  Third
}

namespace MyEnum {
  function isIndex(key):boolean {
    const n = ~~Number(key);
    return String(n) === key && n >= 0;
  }

  const _names:string[] = Object
      .keys(MyEnum)
      .filter(key => !isIndex(key));

  const _indices:number[] = Object
      .keys(MyEnum)
      .filter(key => isIndex(key))
      .map(index => Number(index));

  export function names():string[] {
    return _names;
  }

  export function indices():number[] {
    return _indices;
  }
}

console.log("MyEnum names:", MyEnum.names());
// Prints: MyEnum names: ["First", "Second", "Third"]

console.log("MyEnum indices:", MyEnum.indices());
// Prints: MyEnum indices: [0, 1, 2]

Si noti che è possibile esportare semplicemente _namese _indicesconsts invece di esporli tramite una funzione esportata, ma poiché i membri esportati sono membri dell'enum, è probabilmente più chiaro averli come funzioni in modo che non vengano confusi con i membri dell'enumerazione effettivi.

Sarebbe bello se TypeScript generasse qualcosa di simile automaticamente per tutte le enumerazioni.

— Ricco
fonte
8

Non esiste il concetto di RTTI (informazioni sul tipo di runtime) in TypeScript (pensa: riflessione) quindi per fare ciò, è richiesta la conoscenza del JavaScript traspilato. Quindi, assumendo TypeScript 0.95:

enum MyEnum {
    First, Second, Third
}

diventa:

var MyEnum;
(function(MyEnum) {
    MyEnum[MyEnum["First"] = 0] = "First";
    MyEnum[MyEnum["Second"] = 1] = "Second";
    MyEnum[MyEnum["Third"] = 2] = "Third";
}

Quindi, questo è modellato come un oggetto normale in javascript, dove MyEnum.0 == "First"e MyEnum.First == 0. Quindi, per enumerare tutti i nomi enum, è necessario ottenere tutte le proprietà che appartengono all'oggetto e che non sono anche numeri:

for (var prop in MyEnum) {         
    if (MyEnum.hasOwnProperty(prop) &&
        (isNaN(parseInt(prop)))) {
        console.log("name: " + prop);
    }
}

Ok, quindi ora ti ho detto come farlo, posso dirti che è una cattiva idea . Non stai scrivendo un linguaggio gestito, quindi non puoi portare queste abitudini. È ancora solo un semplice vecchio JavaScript. Se volessi utilizzare una struttura in JavaScript per popolare un qualche tipo di elenco di scelte, userei un semplice vecchio array. Un enum non è la scelta giusta qui, gioco di parole. L'obiettivo di TypeScript è generare JavaScript idiomatico e grazioso. L'uso di enumerazioni in questo modo non preserva questo obiettivo.

— x0n
fonte
5

Ho usato la soluzione proposta da David Sherret e ho scritto una libreria npm che puoi usare denominata enum-values...

Git: valori-enumerazione

// Suppose we have an enum
enum SomeEnum {
  VALUE1,
  VALUE2,
  VALUE3
}

// names will be equal to: ['VALUE1', 'VALUE2', 'VALUE3']
var names = EnumValues.getNames(SomeEnum);

// values will be equal to: [0, 1, 2]
var values = EnumValues.getValues(SomeEnum);
— Slava Shpitalny
fonte
3

Una riga per ottenere un elenco di voci (oggetti / coppie chiave-valore):

Object.keys(MyEnum).filter(a=>a.match(/^\D/)).map(name=>({name, value: MyEnum[name] as number}));
— Venryx
fonte
2 
enum MyEnum {
    First, Second, Third, NUM_OF_ENUMS
}

for(int i = 0; i < MyEnum.NUM_OF_ENUMS; ++i) {
    // do whatever you need to do.
}
— Joe
fonte
5
Funziona solo se l'enum non definisce alcun valore (è ben compresso e incrementale). Ad esempio, i valori di enumerazione potrebbero essere "First = 0x1000" o "PageNotFound = 404". NUM_OF_ENUMS sarà sempre uno maggiore del valore più grande definito, quindi 0x1001 o 405 nei miei esempi.
— Aku
2

Se vuoi associare valori di stringhe alla tua enum, questi metodi non funzionano. Per avere una funzione generica puoi fare:

function listEnum(enumClass) {
    var values = [];
    for (var key in enumClass) {
        values.push(enum[key]);
    }
    values.length = values.length / 2;
    return values;
}

Funziona perché TypeScript aggiungerà le chiavi nel primo passaggio e i valori nel secondo passaggio.

In TypeScript è:

var listEnums = <T> (enumClass: any): T[]=> {
    var values: T[] = [];
    for (var key in enumClass) {
        values.push(enumClass[key]);
    }
    values.length = values.length / 2;
    return values;
};

var myEnum: TYPE[] = listEnums<TYPE>(TYPE);
— Chklang
fonte
1

La risposta di Joe mi ha appena fatto capire che è molto più facile fare affidamento sui primi N tasti numerici che eseguire test più complessi:

function getEnumMembers(myEnum): string[]
{
    let members = []
    for(let i:number = 0; true; i++) {
        if(myEnum[i] === undefined) break
        members.push(myEnum[i])
    }

    return members
}

enum Colors {
    Red, Green, Blue
}

console.log(getEnumMembers(myEnum))
— kbtz
fonte
4
Questo è un presupposto pericoloso perché è possibile definire i valori assegnati alle enumerazioni e non è necessario che siano incrementali e ben confezionati. Ad esempio, non è raro vedere maschere di bit in un enum, o forse una tabella di codici di errore HTML che iniziano da 400.
— Aku
— Juan Mendes
0

per nodejs:

const { isNumber } = require('util');

Object.values(EnumObject)
      .filter(val => isNumber(val))
      .map(val => {
         // do your stuff
      })
— Suben Saha
fonte
0

Iterazione su un'enumerazione

Gli enumeratori di stringa sono i migliori per questo. Ecco un esempio:

// This is a string enum
enum MyEnum {
    First = 'First',
    Second = 'Second',
    Third = 'Third',
}

// An enum is a TS concept
// However his MyEnum compiles to JS object:
//  {
//   "First": "First",
//   "Second": "Second",
//   "Third": "Third"
// } 


// Therefore we can get the keys in the following manner:
const keysArray = Object.keys(MyEnum);

for (const key of keysArray) {
    console.log(key)
}
// [LOG]: "First" 
// [LOG]: "Second" 
// [LOG]: "Third"
— Willem van der Veen
fonte
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.