在 TypeScript 中获取枚举的长度
Get the length of an Enum in TypeScript
要获取枚举的长度:
- 使用该
Object.keys()
方法获取包含枚举键的数组。 - 访问
length
数组上的属性。 - 使用数字枚举时,将结果除以
2
,因为会生成反向映射。
索引.ts
// ✅ For String Enums enum Sizes { Small = 'S', Medium = 'M', Large = 'L', } const length1 = Object.keys(Sizes).length; console.log(length1); // 👉️ 3 // ✅ For Numeric Enums enum SizesNumeric { Small, Medium, Large, } const length2 = Object.keys(SizesNumeric).length / 2; console.log(length2); // 👉️ 3 // ✅ For Mixed Enums (both strings and numbers) enum SizesMixed { Small = 1, Medium = 'test', Large = 3, ExtraLarge = 4, } const length3 = Object.keys(SizesMixed).filter((v) => isNaN(Number(v))).length; console.log(length3); // 👉️ 4
TypeScript 中的枚举是真实的对象,存在于运行时。这就是我们能够将枚举传递给
Object.keys
方法的原因。
该Object.keys()
方法返回一个包含对象键的数组。
索引.ts
// 👇️ ['name', 'age'] console.log(Object.keys({ name: 'Alice', age: 30 }));
但是,数字和字符串枚举的输出是不同的。
索引.ts
// ✅ For String Enums enum Sizes { Small = 'S', Medium = 'M', Large = 'L', } // 👇️ ['Small', 'Medium', 'Large'] console.log(Object.keys(Sizes)); // ✅ For Numeric Enums enum SizesNumeric { Small, Medium, Large, } // 👇️ ['0', '1', '2', 'Small', 'Medium', 'Large'] console.log(Object.keys(SizesNumeric));
请注意,当将数字枚举传递给该
Object.keys
方法时,我们会得到一个包含值和枚举名称的数组,而对于字符串枚举,我们只会得到名称。反向映射允许我们通过值访问数字枚举的键。
索引.ts
// ✅ For Numeric Enums enum SizesNumeric { Small, Medium, Large, } console.log(SizesNumeric[0]); // 👉️ "Small" console.log(SizesNumeric[1]); // 👉️ "Medium"
这就是为什么我们必须将Object.keys()
方法返回的数组长度除以2
数字枚举的原因。
字符串枚举成员根本不会生成反向映射。
如果您正在使用混合枚举(同时包含字符串和数字成员的枚举),则必须过滤掉用于反向映射的键。
换句话说,我们必须从键数组中排除有效数字。
索引.ts
// ✅ For Mixed Enums (both strings and numbers) enum SizesMixed { Small = 1, Medium = 'M', Large = 3, ExtraLarge = 4, } const length3 = Object.keys(SizesMixed).filter((v) => isNaN(Number(v))).length; console.log(length3); // 👉️ 4
该filter()
方法用于过滤掉数组中所有有效数字的键(生成的反向映射键)。
我们不必除以2
,因为我们已经排除了为反向映射生成的所有键。