Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

dynamically access enum in typescript by key

export enum MyEnum{
    Option1,
    Option2,
    Option3
}


string x = 'Option1';

MyEnum[x] throws an error:

Type string is not assignable to type MyEnum

however: MyEnum['Option1'] works.

I need to use MyEnum[x] though (in a method that returns a MyEnum), where x is a calculated value that results in one of the valid enum options, how do I go about it?

like image 462
annepic Avatar asked May 18 '18 18:05

annepic


3 Answers

There are two elegant ways to achieve this 🚀

⭐️ 1st way: just simply turn off the type checking for the next line, which is similar to asserting the type of MyEnum to <any> as done in the @annepic 's answer

// @ts-ignore 
MyEnum[x] 

⭐️ 2nd: If u still want to keep the powerful typechecking feature of TS, choose this

MyEnum[x as keyof typeof MyEnum] 

typeof MyEnum will create an interface that represents the MyEnum object behind the scene and keyof will return a union of string literals, each one is the key in the MyEnum object (in other words, keyof will return a list of keys of a given object/class).

Extra note: Always turn on the Strict flag in tsconfig no matter what (u should only ignore type checking for a single line in very rare and special cases as done above). This configuration will force the developers to define the shape/type/structure for everything, which makes the entire codebase super self-documenting and self-explanatory, especially for your future self and code maintainers. U can quickly infer how a class/object is structured and how a function is used with 100% certainty without even looking at its implementation. JSDoc specifies a set of very strict formatting rules for documenting JS code using comments, but these comments often end up being out of date because they are not changed along with the function evolution. Other benefits of the Strict flag are mentioned in the TypeScript primary doc.

like image 64
Son Xuan Nguyen Avatar answered Oct 18 '22 00:10

Son Xuan Nguyen


Got it to work like this: return (<any>MyEnum)[x];

like image 24
annepic Avatar answered Oct 18 '22 02:10

annepic


You are declaring your string x variable wrong. You should do this:

export enum MyEnum{
    Option1,
    Option2,
    Option3
}


var x = 'Option1';
MyEnum[x];
like image 4
Poku Avatar answered Oct 18 '22 00:10

Poku