keyof 是 TypeScript 中的一个操作符,它用于获取一个类型的所有属性名(键)组成的联合类型。
使用 keyof 操作符可以在编译时获得一个类型的属性名,然后将这些属性名作为联合类型进行处理或操作。它可以用于访问对象的属性,定义映射类型,以及进行类型约束等场景。
下面是一些示例来说明 keyof 的作用:
- 访问对象的属性:
interface Person { name: string; age: number; } const person: Person = { name: "Alice", age: 25, }; type PersonKeys = keyof Person; // 联合类型:"name" | "age" console.log(person["name"]); // 访问对象属性
- 在上述示例中,
PersonKeys类型通过keyof Person获取了Person接口的属性名,即"name"和"age",作为联合类型。 - 定义映射类型:
interface Person { name: string; age: number; } type ReadonlyPerson = { readonly [K in keyof Person]: Person[K]; }; const readonlyPerson: ReadonlyPerson = { name: "Alice", age: 25, }; readonlyPerson.name = "Bob"; // 错误,只读属性无法修改
- 在上述示例中,通过使用
keyof Person,我们创建了一个映射类型ReadonlyPerson,将Person接口的所有属性都设置为只读。 - 进行类型约束:
function getProperty<T, K extends keyof T>(obj: T, key: K): T[K] { return obj[key]; } const person: Person = { name: "Alice", age: 25, }; const name = getProperty(person, "name"); // name 的类型为 string const age = getProperty(person, "age"); // age 的类型为 number const invalid = getProperty(person, "email"); // 错误,"email" 不是 Person 的属性名
- 在上述示例中,
getProperty函数使用了两个泛型参数T和K extends keyof T。通过使用keyof T,我们对第二个参数key进行了类型约束,确保它必须是T类型的属性名。
总结起来,keyof 操作符在 TypeScript 中用于获取一个类型的所有属性名组成的联合类型。它可以用于访问对象的属性,定义映射类型以及进行类型约束等场景,提供了更灵活和安全的类型操作。