简介

TypeScript允许我们遍历某种类型的属性，并通过keyof操作符提取其属性的名称。

keyof操作符可以用于获取某种类型的所有键，其返回类型是联合类型。

使用

interface Person {
  name: string;
  age: number;
  location: string;
}

type K1 = keyof Person; // "name" | "age" | "location"
type K2 = keyof Person[];  // number | "length" | "push" | "concat" | ...
type K3 = keyof { [x: string]: Person };  // string | number

上述例子中，K3返回的是string | number是因为，在js中，对象的key，obj[1] == obj["1"]。

keyof操作类

除了接口，keyof操作符还可以用于操作类。

class Person {
  name: string = "Semlinker";
}

let sname: keyof Person;
sname = "name";

上述例子中，如果把sname = "name"换成sname = "age"，这是会报错的：

Type '"age"' is not assignable to type '"name"'.

这是因为，在定义class类的时候，并没有定义age这个属性。

keyof的作用

例如:在js中，有这样的一种函数处理：

function prop(obj, key) {
    return obj[key];
}

这个函数接口两个参数，obj和key，并返回obj中对应key的属性值。但是，这里存在的问题是，我们并不知道obj是什么，也不知道属性的类型。所以，在TypeScript中，这种情况需要改成这样：

function prop(obj:object, key: string) {
    return obj[key];
}

但是这样是会报错的：

Element implicitly has an 'any' type because expression of type 'string' can't be used to index type '{}'.
// 元素隐式地拥有 `any` 类型，因为 `string` 类型不能被用于索引 `{}` 类型

解决的办法：obj的类型是any，即(obj as any)[key]。很显然，因为any的原因，这不是一个很好的方案。既然学习的是keyof操作符，那么很显然，这里会用到keyof，哈哈哈哈哈~

先来看下prop函数，这个函数是为了获取对象中的指定属性的值，那么，在使用的时候，当然是想要得到真实存在的属性的值，那么在TypeScript中，就需要进行指定。那要怎么样去保证用户输入的属性是真实存在的呢？必定是要去限制属性名的范围了。

下面有请本次的主角keyof登场：

type Todo = {
  id: number;
  text: string;
  done: boolean;
}

const todo: Todo = {
  id: 1,
  text: "Learn TypeScript keyof",
  done: false
}

function prop<T extends object, K extends keyof T>(obj: T, key: K) {
  return obj[key];
}

const id = prop(todo, "id"); // const id: number
const text = prop(todo, "text"); // const text: string
const done = prop(todo, "done"); // const done: boolean

解释一下上面的代码： 首先定义一个泛型类型T，并且使用到extends，类型约束，使泛型类型T必须是object类型的子类型，也就是Todo的子类型，然后使用keyof获取T类型的所有键，其返回类型是联合类型，也即是number | string | boolean，最后再次使用extends关键字，将k类型必须是keyof T的子类型。

此时在使用的时候，用户再次输入一个不存在的属性时，编译器就会报错提示了

作者：路过的前端小菜鸟
链接：https://juejin.cn/post/7032974613608923167

本文内容仅供个人学习、研究或参考使用，不构成任何形式的决策建议、专业指导或法律依据。未经授权，禁止任何单位或个人以商业售卖、虚假宣传、侵权传播等非学习研究目的使用本文内容。如需分享或转载，请保留原文来源信息，不得篡改、删减内容或侵犯相关权益。感谢您的理解与支持！

链接: https://fly63.com/article/detial/10831