How to programmatically enumerate an enum type?

by

This is the JavaScript output of that enum:

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

Which is an object like this:

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

Enum Members with String Values

TypeScript 2.4 added the ability for enums to possibly have string enum member values. So it’s possible to end up with an enum that look like the following:

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

Getting Member Names

We can look at the example immediately above to try to figure out how to get the enum members:

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

Here’s what I came up with:

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

Member Values

Once, we have the names, we can loop over them to get the corresponding value by doing:

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

Extension Class

I think the best way to do this is to create your own functions (ex. EnumEx.getNames(MyEnum)). You can’t add a function to an 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);
    }
}

More Related Contents:

  1. How to get names of enum entries?
  2. How do the different enum variants work in TypeScript?
  3. Enum as Parameter in TypeScript
  4. Generic type to get enum keys as union string in typescript?
  5. What is an idiomatic way of representing enums in Go?
  6. Check if value exists in enum in TypeScript
  7. Unwrap inner type when enum variant is known
  8. Dart How to get the name of an enum as a String
  9. Cast int to enum strings in Typescript
  10. Typescript has unions, so are enums redundant?
  11. In Rust, is there a way to iterate through the values of an enum?
  12. Typescript: string literal union type from enum
  13. Does Dart support enumerations?
  14. How can I loop through enum values for display in radio buttons? [duplicate]
  15. TypeScript enum to object array
  16. Effective Enums in Kotlin with reverse lookup?
  17. Pass enums in angular2 view templates
  18. How to use enum as index key type in typescript?
  19. How do I conditionally check if an enum is one variant or another?
  20. Can traits be used on enum types?
  21. Using enums as types allows values that don’t exist in the enum
  22. Typescript `enum` from JSON string
  23. How to get an enum value from a string value in Java
  24. Easy way to use variables of enum types as string in C?
  25. Are strongly-typed functions as parameters possible in TypeScript?
  26. What’s the best way to implement `next` and `previous` on an enum type?
  27. Is there a way to “extract” the type of TypeScript interface property?
  28. Cross-project references between two projects
  29. How to loop over object properties with ngFor in Angular
  30. Typescript Promise rejection type

Leave a Comment