使用对象文字作为 TypeScript 枚举值

我有一个枚举:

export enum PizzaSize {
SMALL =  0,
MEDIUM = 1,
LARGE = 2
}

但是这里我想使用一对值: 例如 SMALL,我想说它有 key0value100。我努力使用:

export enum PizzaSize {
SMALL =  { key: 0, value: 100 },
// ...
}

但是 TypeScript 不接受这个,我该怎么做呢?

93682 次浏览

Update: find @Javarome's answer below, which is more elegant. I suggest using his way.

If you need to use Type, try adding some code. usage: getPizzSizeSpec(PizzaSize.small).value

enum PizzaSize {
small,
medium,
large
}
interface PizzaSizeSpec {
key: number,
value: number
}
function getPizzaSizeSpec(pizzaSize: PizzaSize): PizzaSizeSpec {
switch (pizzaSize) {
case PizzaSize.small:
return {key:0, value: 25};
case PizzaSize.medium:
return {key:0, value: 35};
case PizzaSize.large:
return {key:0, value: 50};
}
}

TypeScript supports numeric or string-based enums only, so you have to emulate object enums with a class (which will allow you to use it as a type in a function declaration):

export class PizzaSize {
static readonly SMALL  = new PizzaSize('SMALL', 'A small pizza');
static readonly MEDIUM = new PizzaSize('MEDIUM', 'A medium pizza');
static readonly LARGE  = new PizzaSize('LARGE', 'A large pizza');


// private to disallow creating other instances of this type
private constructor(private readonly key: string, public readonly value: any) {
}


toString() {
return this.key;
}
}

then you can use the predefined instances to access their value:

const mediumVal = PizzaSize.MEDIUM.value;

or whatever other property/property type you may want to define in a PizzaSize.

and thanks to the toString() overriding, you will also be able to print the enum name/key implicitly from the object:

console.log(PizzaSize.MEDIUM);  // prints 'MEDIUM'

Object.freeze makes it read only and prevents more properties being added:

const pizzaSize = Object.freeze({
small: { key: 0, value: 25 },
medium: { key: 1, value: 35 },
large: { key: 2, value: 50 }
})

As of Typescript 3.4, you can use a combination of keyof typeof and const assertions to create objects that can have the same type safety as enums, and still hold complex values.

By creating a type with the same name as the const, you can have the same exhaustiveness checks that normal enums have.

The only wart is that you need some key in the complex object (I'm using value here) to hold the name of the enum member (if anyone can figure out a helper function that can build these objects in a typesafe way, I'd love to see it! I couldn't get one working).

export const PizzaSize = {
small: { value: 'small', key: 0, size: 25 },
medium: { value: 'medium', key: 1, size: 35 },
large: { value: 'large', key: 2, size: 50 },
} as const


export type PizzaSize = keyof typeof PizzaSize


// if you remove any of these cases, the function won't compile
// because it can't guarantee that you've returned a string
export function order(p: PizzaSize): string {
switch (p) {
case PizzaSize.small.value: return 'just for show'
case PizzaSize.medium.value: return 'just for show'
case PizzaSize.large.value: return 'just for show'
}
}


// you can also just hardcode the strings,
// they'll be type checked
export function order(p: PizzaSize): string {
switch (p) {
case 'small': return 'just for show'
case 'medium': return 'just for show'
case 'large': return 'just for show'
}
}

In other files this can be used simply, just import PizzaSize.

import { PizzaSize } from './pizza'


console.log(PizzaSize.small.key)


type Order = { size: PizzaSize, person: string }

Also notice how even objects that are usually mutable can't be mutated with the as const syntax.

const Thing = {
ONE: { one: [1, 2, 3] }
} as const


// this won't compile!! Yay!!
Thing.ONE.one.splice(1, 0, 0)

You can use a typed const to achieve this:

export const PizzaSize: {
[key: string]: { key: string, value: string };
} = {
SMALL: { key: 'key', value: 'value' }
};

Optionally you can extract the type information to separate interface declarations:


interface PizzaSizeEnumInstance {
key: string;
value: string;
}


interface PizzaSizeEnum {
[key: string]: PizzaSizeEnumInstance;
}


export const PizzaSize: PizzaSizeEnum = {
SMALL: { key: 'key', value: 'value' }
};

I think to get to what you want, something like this will work

interface PizzaInfo {
name: string;
cost_multiplier: number;
}


enum PizzaSize {
SMALL,
MEDIUM,
LARGE,
}


const pizzas: Record<PizzaSize, PizzaInfo> = {
[PizzaSize.SMALL]: { name: "Small", cost_multiplier: 0.7 },
[PizzaSize.MEDIUM]: { name: "Medium", cost_multiplier: 1.0 },
[PizzaSize.LARGE]: { name: "Large", cost_multiplier: 1.5 },
};


const order = PizzaSize.SMALL;
console.log(pizzas[order].name);  // "Small"