Como enumerar programaticamente um tipo de enum?

91

Digamos que eu tenha um texto datilografado enum, MyEnumcomo segue:

enum MyEnum {
    First,
    Second,
    Third
}

Qual seria a melhor maneira no TypeScript 0.9.5 de produzir uma matriz de enumvalores? Exemplo:

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

Respostas:

193

Esta é a saída JavaScript desse enum:

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

Que é um objeto como este:

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

Membros Enum com valores de string

TypeScript 2.4 adicionou a capacidade de enums para possivelmente ter valores de membro de enum de string. Portanto, é possível terminar com um enum parecido com o seguinte:

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 = {}));

Obtendo nomes de membros

Podemos olhar o exemplo imediatamente acima para tentar descobrir como obter os membros enum:

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

Aqui está o que eu inventei:

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

Valores de Membro

Assim que tivermos os nomes, podemos percorrê-los para obter o valor correspondente, fazendo:

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

Classe de extensão

Acho que a melhor maneira de fazer isso é criar suas próprias funções (ex. EnumEx.getNames(MyEnum)). Você não pode adicionar uma função a um enum.

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 (porque muitas pessoas votaram positivamente nesta resposta), não consigo fazer isso funcionar no TS Playground: shorturl.me/jJ8G2t Estou fazendo algo errado?
— Peter,
1
@Peter Eu atualizei a resposta para incluir informações sobre enums de string. Além disso, convém usar uma for ofinstrução em vez defor in
— David Sherret,
24

Com TypeScript> = 2.4, você pode definir enums de string:

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

Saída 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 = {}));

Que é um objeto como este:

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

Assim, no caso de enums de string, não há necessidade de filtrar coisas Object.keys(Color)e Object.values(Color)(*) são suficientes:

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
*/

Veja o exemplo online no playground do TypeScript

(*) Polyfill necessário para navegadores antigos, consulte https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Object/values#Browser_compatibility

— tanguy_k
fonte
Este tem o erroElement 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 eu consertei com um elenco:Object.keys(Color) as (keyof typeof Color)[]
— tanguy_k
9

Você pode adicionar funções para obter os nomes e índices do enum:

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]

Observe que você pode apenas exportar as consts _namese em _indicesvez de expô-las por meio de uma função exportada, mas como os membros exportados são membros do enum, é indiscutivelmente mais claro tê-los como funções para que não sejam confundidos com os membros reais do enum.

Seria bom se o TypeScript gerasse algo assim automaticamente para todos os enums.

— Rico
fonte
8

Não há conceito de RTTI (informações de tipo em tempo de execução) no TypeScript (pense: reflexão), portanto, para fazer isso, é necessário conhecimento do JavaScript transpilado. Portanto, assumindo TypeScript 0,95:

enum MyEnum {
    First, Second, Third
}

torna-se:

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

Então, isso é modelado como um objeto regular em javascript, onde MyEnum.0 == "First"e MyEnum.First == 0. Portanto, para enumerar todos os nomes de enum, você precisa obter todas as propriedades que pertencem ao objeto e que também não são números:

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

Ok, agora que disse a você como fazer, posso dizer que é uma má ideia . Você não está escrevendo uma linguagem gerenciada, então não pode trazer esses hábitos. Ainda é um simples JavaScript antigo. Se eu quisesse usar uma estrutura em JavaScript para preencher algum tipo de lista de opções, usaria um array simples e antigo. Um enum não é a escolha certa aqui, trocadilho intencional. O objetivo do TypeScript é gerar um JavaScript bonito e idiomático. Usar enums dessa maneira não preserva esse objetivo.

— x0n
fonte
5

Usei a solução proposta por David Sherret e escrevi uma biblioteca npm que você pode usar chamada enum-values...

Git: enum-values

// 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

Uma linha para obter uma lista de entradas (objetos / pares de valor-chave):

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
Isso só funciona se seu enum não definir nenhum valor (é bem compactado e incremental). Os valores de enum podem ser "First = 0x1000" ou "PageNotFound = 404", por exemplo. NUM_OF_ENUMS sempre será um maior do que o maior valor definido, então 0x1001 ou 405 em meus exemplos.
— Aku,
2

Se você deseja associar valores de strings ao seu enum, esses métodos não funcionam. Para ter uma função genérica, você pode fazer:

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

Funciona porque o TypeScript adicionará chaves na primeira etapa e valores na segunda etapa.

No 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

A resposta de joe me fez perceber que é muito mais fácil confiar nas primeiras N teclas numéricas do que fazer testes mais complexos:

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
Essa é uma suposição perigosa porque é possível definir os valores atribuídos a enums e eles não precisam ser incrementais e bem compactados. Não é incomum ver máscaras de bits em um enum, por exemplo, ou talvez uma tabela de códigos de erro HTML que começam em 400.
— Aku
— Juan Mendes
0

para nodejs:

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

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

Iterando sobre um enum

String Enums são mais usados ​​para isso. Aqui está um exemplo:

// 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
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.