TypeScript: Infer enum value type from enum type

Question

I wrote a function returning all values of a given enum as array. The implementation works, but I have a problem with the type of the return value.

enum Foo {
    FOO_1 = "FOO_1",
    FOO_2 = "FOO_2",
}

function getEnumValues<T>(e:T): T[] {
    let keys: string[] = Object.keys(e);
    keys = keys.filter(key => e[key] !== undefined);
    return keys.map(key => e[key]);
}

const fooValues:Foo[] = getEnumValues(Foo);

I get this error:

Error:(46, 7) TS2322: Type '(typeof Foo)[]' is not assignable to type 'Foo[]'. Type 'typeof Foo' is not assignable to type 'Foo'.

How can I change the signature of getEnumValues() in order to return the type Foo[] here?

Titian Cernicova-Dragomir · Accepted Answer · 2018-05-08 06:58:35Z

13

You need to change the definition a bit to infer the type of the enum member, right now T will be the enum object itself (aka typeof T)

enum Foo {
    FOO_1 = "FOO_1",
    FOO_2 = "FOO_2",
}

function getEnumValues<TEnum, TKeys extends string>(e: { [key in TKeys]: TEnum }): TEnum[] {
    let keys = Object.keys(e) as Array<TKeys>;
    keys = keys.filter(key => e[key] !== undefined);
    return keys.map(key => e[key]);
}

const fooValues: Foo[] = getEnumValues(Foo);

Note that while this works for enums, it will work for any object it is not restricted to enums

edited May 8, 2018 at 6:58

answered May 8, 2018 at 6:56

Titian Cernicova-Dragomir

253k37 gold badges465 silver badges395 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Marco Over a year ago

Apart from being way less specific, you could just change e:any, and it would work too.

Titian Cernicova-Dragomir Over a year ago

@Marco well .. you can type anything as any and it will work. The art of using Typescript is never using any :P. Also if you use e:any you have to also give a type argument to have the corect enum type (ie getEnumValues<Foo>(Foo), like this it is inferred.

Marco Over a year ago

It does work without specifying the concrete type - at least in this case.

Marco Over a year ago

Agreed. I'm just being lazy here.

Alice Rocheman · Accepted Answer · 2021-09-07 15:08:36Z

0

Personaly I do this:

enum Foo {
    FOO_1 = "FOO_1",
    FOO_2 = "FOO_2",
}

const fooValues:Foo[] = Object.values(Foo);

answered Sep 7, 2021 at 15:08

Alice Rocheman

9961 gold badge7 silver badges8 bronze badges

Collectives™ on Stack Overflow

TypeScript: Infer enum value type from enum type

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related