Jak programowo wyliczyć typ wyliczenia?

90

Że mam maszynopis enum, MyEnumw następujący sposób:

enum MyEnum {
    First,
    Second,
    Third
}

Jaki byłby najlepszy sposób tworzenia tablicy enumwartości w języku TypeScript 0.9.5 ? Przykład:

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
źródło

Odpowiedzi:

192

Oto wynik JavaScript tego wyliczenia:

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

Który jest takim obiektem:

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

Enum Członkowie z wartościami ciągu

W języku TypeScript 2.4 dodano możliwość, aby wyliczenia mogły mieć wartości składowe wyliczeń w postaci ciągów. Możliwe jest więc wyliczenie, które wygląda następująco:

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

Pobieranie nazw członków

Możemy spojrzeć na przykład bezpośrednio powyżej, aby spróbować dowiedzieć się, jak uzyskać elementy wyliczeniowe:

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

Oto, co wymyśliłem:

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

Wartości członkowskie

Kiedy już mamy nazwy, możemy je zapętlić, aby uzyskać odpowiednią wartość, wykonując:

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

Klasa rozszerzenia

Myślę, że najlepszym sposobem na to jest stworzenie własnych funkcji (np. EnumEx.getNames(MyEnum)). Nie możesz dodać funkcji do wyliczenia.

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
źródło
Co ciekawe (ponieważ wiele osób zagłosowało za tą odpowiedzią), nie mogę zmusić tego do działania w TS Playground: shorturl.me/jJ8G2t Czy robię coś złego?
— Peter
1
@Peter Zaktualizowałem odpowiedź, aby zawierała informacje o wyliczeniach ciągów. Będziesz także chciał użyć for ofoświadczenia zamiastfor in
— David Sherret
24

Z TypeScript> = 2.4 można zdefiniować wyliczenia w postaci ciągów:

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

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

Który jest takim obiektem:

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

Dlatego w przypadku wyliczeń ciągów nie ma potrzeby filtrowania elementów, Object.keys(Color)a Object.values(Color)(*) wystarczą:

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

Zobacz przykład online na placu zabaw TypeScript

(*) W przypadku starszych przeglądarek wymagane jest narzędzie Polyfill, patrz https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Object/values#Browser_compatibility

— tanguy_k
źródło
To jest błądElement 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 Naprawiłem to za pomocą obsady:Object.keys(Color) as (keyof typeof Color)[]
— tanguy_k
wielkie dzięki!
— Jonas
9

Możesz dodać funkcje, aby uzyskać nazwy i indeksy wyliczenia:

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]

Zauważ, że mógłby po prostu wyeksportować _namesi _indicesconsts zamiast wystawiania ich przez eksportowanych funkcji, ale ponieważ wywożone członkami są członkowie wyliczenia jest prawdopodobnie wyraźniejsze mieć je jako funkcje, więc nie są one mylone z rzeczywistymi członkami enum.

Byłoby miło, gdyby TypeScript generował coś takiego automatycznie dla wszystkich wyliczeń.

— Bogaty
źródło
7

Nie ma pojęcia RTTI (informacje o typie środowiska uruchomieniowego) w TypeScript (myśl: odbicie), więc aby to zrobić, wymagana jest znajomość transpiled JavaScript. Więc zakładając TypeScript 0.95:

enum MyEnum {
    First, Second, Third
}

staje się:

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

Tak więc jest to modelowane jako zwykły obiekt w javascript, gdzie MyEnum.0 == "First"i MyEnum.First == 0. Tak więc, aby wyliczyć wszystkie nazwy wyliczeń, musisz pobrać wszystkie właściwości, które należą do obiektu, a także nie są liczbami:

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

Ok, teraz już ci powiedziałem, jak to zrobić, mogę ci powiedzieć, że to zły pomysł . Nie piszesz języka zarządzanego, więc nie możesz wprowadzić tych nawyków. To wciąż zwykły stary JavaScript. Gdybym chciał użyć struktury w JavaScript do zapełnienia jakiejś listy wyborów, użyłbym zwykłej starej tablicy. Wyliczenie nie jest tutaj właściwym wyborem, gra słów zamierzona. Celem TypeScript jest wygenerowanie idiomatycznego, ładnego JavaScript. Stosowanie wyliczeń w ten sposób nie zachowuje tego celu.

— x0n
źródło
5

Skorzystałem z rozwiązania zaproponowanego przez Davida Sherreta i napisałem bibliotekę npm, której możesz użyć o nazwie enum-values...

Git: wartości-wyliczenia

// 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
źródło
3

Jednowierszowy do pobrania listy wpisów (obiekty / pary klucz-wartość):

Object.keys(MyEnum).filter(a=>a.match(/^\D/)).map(name=>({name, value: MyEnum[name] as number}));
— Venryx
źródło
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
źródło
5
Działa to tylko wtedy, gdy wyliczenie nie definiuje żadnych wartości (jest dobrze spakowane i przyrostowe). Na przykład wartościami wyliczenia mogą być „First = 0x1000” lub „PageNotFound = 404”. NUM_OF_ENUMS zawsze będzie o jeden większy niż największa zdefiniowana wartość, więc w moich przykładach 0x1001 lub 405.
— Aku,
2

Jeśli chcesz skojarzyć wartości ciągów z wyliczeniem, te metody nie działają. Aby mieć funkcję ogólną, możesz:

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

Działa, ponieważ TypeScript doda klucze w pierwszym kroku i wartości w drugim kroku.

W języku TypeScript jest to:

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
źródło
1

Odpowiedź joe właśnie uświadomiła mi, że znacznie łatwiej jest polegać na pierwszych N klawiszach numerycznych niż wykonywanie bardziej złożonych testów:

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
źródło
4
Jest to niebezpieczne założenie, ponieważ możliwe jest zdefiniowanie wartości przypisanych do wyliczeń i nie muszą one być przyrostowe i dobrze spakowane. Nierzadko zdarza się na przykład zobaczyć maski bitowe w wyliczeniu lub być może tabelę kodów błędów HTML, które zaczynają się od 400.
— Aku
— Juan Mendes,
0

dla nodejs:

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

Object.values(EnumObject)
      .filter(val => isNumber(val))
      .map(val => {
         // do your stuff
      })
— Suben Saha
źródło
0

Iterowanie po wyliczeniu

Do tego celu najlepiej stosować wyliczenia typu string. Oto przykład:

// 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
źródło
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.