Converting String array to Enum in Typescript

Question

I am playing around with Typescript a little.

Suppose I have an object such as this

let colors = { RED: "r", GREEN: "g", BLUE: "b" }

Now I want to convert this into an enum type

enum Colors = { RED = "r", GREEN = "g", BLUE = "b" }

Update:

I want the generated typings for the colors object such that if I add another key to the colors object, It should be included in the typings.

If I do

colors['YELLOW'] = "y"

then the generated typings should be

declare enum colors { RED = "r", GREEN = "g", BLUE = "b", YELLOW = "y" }

instead, the generate typings are

declare const colors { [x: string]: string }

How can I achieve this?

What useage do you have in mind? Don't think you can create an actual enum type based on an object literal, but you can create an object that closely mimicks the behavior of one. — Titian Cernicova-Dragomir
– Titian Cernicova-Dragomir, Commented Jan 28, 2018 at 7:43
@TitianCernicova-Dragomir I have updated the Question with what I actually want to achieve — besrabasant
– besrabasant, Commented Jan 28, 2018 at 8:01
I expected an Array, not an Object. Your question title is completely unrelated to the body. This would be an Array: ["red", "blue", "green"] and I would expect it to be converted into a enum Color { red, blue, green } — Soldeplata Saketos
– Soldeplata Saketos, Commented Jun 30, 2021 at 8:33

Yash · Accepted Answer · 2018-01-28 07:54:34Z

Enums « Enums allow us to define a set of named constants. Using enums can make it easier to document intent, or create a set of distinct cases. TypeScript provides both numeric and string-based enums.

TypeScript ^2.4+ String enums - Prior to TypeScript 2.4, TypeScript only supported number-based enums in that case just cast the string literal to any before assigning, Using 2.4+ then any would be no longer necessary

enum Colors { RED = <any>"R", GREEN = <any>"G", BLUE = <any>"B", }

Java script ^{Standard Style}

var Colors; (function (Colors) { Colors["RED"] = "r"; Colors["GREEN"] = "g"; Colors["BLUE"] = "b"; })(Colors || (Colors = {}));

Check in TypeScript Fiddle fiddlesalad, typescriptlang

Below Utility function to create a K:V from a list of strings may help you.

function strEnum<T extends string>(o: Array<T>): {[K in T]: K} { return o.reduce((res, key) => { res[key] = key; return res; }, Object.create(null)); } let dynamicArrayJSON = [ 'RED', 'BLUE', 'GREEN' ] const Colors = strEnum( dynamicArrayJSON )

@see

I want to convert the above object type to an enum type.
static json object or dynamic json object you want to convert to enum
This is ace! I've been looking for a way to do this, thanks!

Collectives™ on Stack Overflow

Converting String array to Enum in Typescript

1 Answer 1

5 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Linked

Related