Getting an Array of all items from an Enum in Typescript

Question

I'm trying to get all items of a TypeScript Enumeration. For this I use the following, generic function:

static getAllValues<T>(enumeration: T): Array<T>{
    let enumKeys: Array<T> = Object.keys(enumeration).map(k => enumeration[k]);

    let items: Array<T> = new Array<T>();
    for(let elem of enumKeys){
        if (typeof(elem) === "number"){
            items.push(elem)
        }
    }

    return items;
}

By calling this function with an Enum of the Type ExampleEnum like

export enum ExampleEnum {
 FOO,
 BAR,
 FOOBAR
}

I expected a return value from the type Array<ExampleEnum> but the response is from the type Array<typeof ExampleEnum>.

Does anyone know how to fix it, to get a return from the type Array<ExampleEnum>?

(I'm using TypeScript 3.2.1)

Roberto Zvjerković · Accepted Answer · 2019-03-11 08:25:32Z

3

You are passing in the container object for the enum so T will be the container object. The container object is not the same type as the enume, it is an object that contains values of the enum, so its values will be of the enum type which we can get at using T[keyof T]

function getAllValues<T>(enumeration: T): Array<T[keyof T]> {
    let enumKeys = Object.keys(enumeration).map(k => enumeration[k]);

    let items = new Array<T[keyof T]>();
    for (let elem of enumKeys) {
        if (typeof (elem) === "number") {
            items.push(elem as any)
        }
    }

    return items;
}

export enum ExampleEnum {
    FOO,
    BAR,
    FOOBAR
}

getAllValues(ExampleEnum);

edited Mar 11, 2019 at 8:25

Roberto Zvjerković

10.2k4 gold badges31 silver badges49 bronze badges

answered Mar 11, 2019 at 8:23

Titian Cernicova-Dragomir

253k37 gold badges466 silver badges396 bronze badges

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

Comments

Romain Deneau · Accepted Answer · 2019-03-12 09:23:23Z

3

What do you think of this version of the function, shorter and still handling string enum too?

function enumValues<T extends object>(enumeration: T): Array<T[keyof T]> {
    return Object
        .keys(enumeration)
        .filter(k => isNaN(Number(k)))
        .map(k => enumeration[k]);
}

enum ExampleEnum {
    FOO = 10,
    BAR = 20,
    BAZ = 30
}

console.log(enumValues(ExampleEnum)); // [10, 20, 30]

enum ExampleStringEnum {
    FOO = 'F',
    BAR = 'B',
    BAZ = 'Z'
}

console.log(enumValues(ExampleStringEnum)); // ['F', 'B', 'Z']

answered Mar 12, 2019 at 9:23

Romain Deneau

3,09116 silver badges27 bronze badges

1 Comment

S. Wilhelm Over a year ago

Wow, I did not think about that. Although I do not need the string values but through the early filtering, the computing effort will probably be significantly reduced. Thanks!

Collectives™ on Stack Overflow

Getting an Array of all items from an Enum in Typescript

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related