用于 TypeScript 枚舉的實用輔助函數
作者：CUGGZ
在 TypeScript 中使用枚舉類型時，下面這些輔助函數可能會很有用，趕緊來看一下吧！
在 TypeScript 中使用枚舉類型時，下面這些輔助函數可能會很有用，趕緊來看一下吧!
輔助函數將以下面的枚舉為例進行測試：
enum DayOfWeek {
Monday = 1,
Tuesday = 2,
Wednesday = 3,
Thursday = 4,
Friday = 5,
Saturday = 6,
Sunday = 7,
}
type Enum = { [s: number]: string };
一 檢查枚舉是否包含某個key
該方法可以用來檢查一個枚舉中是否包含某個key，代碼如下：
function isEnumKey<T extends Enum>(enumSrc: T, key: unknown) : key is keyof T {
return Number.isInteger(enumSrc[key as keyof T]);
}
測試：
console.log(isEnumKey(DayOfWeek, DayOfWeek[DayOfWeek.Friday])); // true
console.log(isEnumKey(DayOfWeek, DayOfWeek[DayOfWeek.Monday])); // true
console.log(isEnumKey(DayOfWeek, "hello" )); // false
二 檢查枚舉是否包含某個value
該方法可以用來檢查一個枚舉中是否包含某個枚舉值，代碼如下：
function isEnumValue<T extends Enum>(enumSrc: T, value: unknown): value is T[keyof T] {
return Number.isInteger(enumSrc[enumSrc[value as keyof T] as any as keyof T]);
}
測試：
console.log(isEnumValue(DayOfWeek, DayOfWeek.Friday)); // true
console.log(isEnumValue(DayOfWeek, DayOfWeek.Monday)); // true
console.log(isEnumValue(DayOfWeek, 996)); // false
三 將枚舉轉化為key列表
該方法可以用來將枚舉轉化為key列表，也就是將所有的枚舉key存放在一個數組中，代碼如下：
function enumToKeys<T extends Enum>(enumSrc: T): (keyof T)[] {
return Object.keys(enumSrc).filter((key: keyof T | any) => isEnumKey(enumSrc, key)) as (keyof T)[];
}
測試：
console.log(enumToKeys(DayOfWeek));
輸出結果：
[
'Monday',
'Tuesday',
'Wednesday',
'Thursday',
'Friday',
'Saturday',
'Sunday'
]
四 將枚舉轉化為value列表
該方法可以用來將枚舉中所有的枚舉值提取出來，放在一個數組中，代碼如下：
function enumToValues<T extends Enum>(enumSrc: T): T[keyof T][] {
return enumToKeys(enumSrc)
.map((key: keyof T) => enumSrc[key]);
}
測試：
console.log(enumToValues(DayOfWeek));
輸出結果：
[ 1, 2, 3, 4, 5, 6, 7 ]
五 將枚舉值轉化為對應的key
該方法可以通過枚舉值獲取枚舉中對應的key，代碼如下：
function enumValueToKey<T extends Enum>(enumSrc: T, value: T[keyof T]): keyof T | undefined {
return (enumSrc as any)[value];
}
測試：
console.log(enumValueToKey(DayOfWeek, DayOfWeek.Friday)); // Friday
console.log(enumValueToKey(DayOfWeek, DayOfWeek.Monday)); // Monday
console.log(enumValueToKey(DayOfWeek, 996)); // undefined
六 將枚舉轉換為鍵值對數組
該方法可以用來將枚舉轉化為鍵值對數組，代碼如下：
function enumToEntries<T extends Enum>(enumSrc: T): [keyof T, T[keyof T]][] {
return enumToValues(enumSrc)
.map((value: T[keyof T]) =>
[enumValueToKey(enumSrc, value) as keyof T, value]);
}
測試：
console.log(enumToEntries(DayOfWeek));
輸出結果：
[
[ 'Monday', 1 ],
[ 'Tuesday', 2 ],
[ 'Wednesday', 3 ],
[ 'Thursday', 4 ],
[ 'Friday', 5 ],
[ 'Saturday', 6 ],
[ 'Sunday', 7 ]
]
七 將枚舉轉換為對象數組
該方法可以用來將枚舉轉化為對象數組，鍵值可以自定義，代碼如下：
function fromEnum<T extends Enum, C>(
enumSrc: T,
projection: (item: [keyof T, T[keyof T]], index: number, array: [keyof T, T[keyof T]][]) => C,
skip?: (value: [keyof T, T[keyof T]], index: number, array: [keyof T, T[keyof T]][]) => boolean
) {
let entries = enumToEntries(enumSrc);
if (skip) entries = entries.filter(skip);
return entries.map(projection);
}
測試：
interface Option<T> {
label: keyof T;
value: T[keyof T];
}
const options: Option<typeof DayOfWeek>[] = fromEnum(
DayOfWeek,
([label, value]: [keyof typeof DayOfWeek, DayOfWeek]) => ({
label,
value,
})
);
console.log(options);
輸出結果：
[
{ label: 'Monday', value: 1 },
{ label: 'Tuesday', value: 2 },
{ label: 'Wednesday', value: 3 },
{ label: 'Thursday', value: 4 },
{ label: 'Friday', value: 5 },
{ label: 'Saturday', value: 6 },
{ label: 'Sunday', value: 7 }
]
責任編輯：姜華
來源：
前端充電寶
