说明
现在 Typescription 支持 enum, 但有时你可能需要比 内建的 enums 给您; 此软件包是从一个从打字符链接的格子中的例子修改出来的 我现在找不到的问题,但只要说,尽管我们稍作修改 对我们来说不是独创的.
安装
npm install --save @gradecam/tsenum
基本用途
import {MakeEnum, TypeFromEnum} from 'tsenum';
const Colors = MakeEnum({
Red: 'red',
Blue: 'blue',
Green: 'green',
Violet: 'violet',
Black: 'black'
});
type Colors = TypeFromEnum<typeof Colors>;
// type Colors = 'red' | 'blue' | 'green' | 'violet' | 'black'
// value Colors is a frozen object with the keys expected
// typeof Colors.Red is 'red', et al
carColor: Colors = 'red'; // valid
carColor = Colors.Green; // valid
carColor = 'yellow'; // typescript error, not a valid color
组合类型
MakeEnum将多个enum对象合并为一个(最多为9个),允许您合并类型.
import {MakeEnum, TypeFromEnum} from 'tsenum';
const PrimaryColors = MakeEnum({
Red: 'red',
Blue: 'blue',
Green: 'green',
});
type PrimaryColors = TypeFromEnum<typeof PrimaryColors>;
const SecondaryColors = MakeEnum({
Yellow: 'yellow',
Cyan: 'cyan',
Magenta: 'magenta'
});
type SecondaryColors = TypeFromEnum<typeof SecondaryColors>;
const AllColors = MakeEnum(PrimaryColors, SecondaryColors);
type AllColors = TypeFromEnum<typeof AllColors>;
// type AllColors = 'red' | 'blue' | 'green' | 'yellow' | 'cyan' | 'magenta'
获取一系列可能的值
有时您可能想要一系列可能的值, 例如在 mongoose 中定义 enum 类型时
计划 由于enum是一个对象,你可以使用 Object.values 获取:
import {MakeEnum, TypeFromEnum} from 'tsenum';
const PrimaryColors = MakeEnum({
Red: 'red',
Blue: 'blue',
Green: 'green',
});
type PrimaryColors = TypeFromEnum<typeof PrimaryColors>;
const PrimaryColorList = Object.values(PrimaryColors); // ['red', 'blue', 'green']
// typeof PrimaryColorList = Array<'red'|'blue'|'green'>
允许的值类型
当前您可以使用任意字符串、 数字或布尔作为值