类型保护函数 isOfType

isOfType 是一个类型保护函数，它用于在运行时检查传入的变量是否具有指定类型的特定属性。以下是对这个方法的设计和使用文档的描述：

设计

export const isOfType = <T>(
  varToBeChecked: any,
  propertyToCheckFor: keyof T
): varToBeChecked is T => {
  return (varToBeChecked as T)[propertyToCheckFor] !== undefined
}

<T> 是泛型参数，表示待检查对象的类型。
varToBeChecked 参数接收任何类型的值，我们将尝试判断其是否为类型 T 的实例。
propertyToCheckFor 参数要求是 keyof T 类型，即 T 类型的键。这意味着你只能传递 T 类型中存在的属性名。

方法内部逻辑：

使用类型断言 (varToBeChecked as T) 将 varToBeChecked 转换为类型 T，以便访问它的属性。
检查转换后的变量中是否存在指定的 propertyToCheckFor 属性，并且该属性不是 undefined。
如果存在并非 undefined，则返回 true，表明 varToBeChecked 实际上是一个类型 T 的实例；否则返回 false。

使用文档

使用场景

当你有一个不确定类型的变量，并希望确认它是否属于某种类型（包含特定属性），可以使用此函数进行类型保护。

示例

假设我们有以下接口定义：

interface User {
  id: number;
  name: string;
}

然后我们可以这样使用 isOfType 函数：

let maybeUser: any = {...}; // 假设这可能是一个 User 对象或别的类型

if (isOfType<User>(maybeUser, 'id')) {
  console.log(maybeUser.id); // TypeScript 现在知道此处 maybeUser 的类型至少包含了 'id' 属性，因此不会报错
}

if (isOfType<User>(maybeUser, 'name')) {
  console.log(maybeUser.name); // 同理，这里也不会报错
}

请注意，虽然这个方法可以提供一定的类型安全性，但仅凭某个属性的存在并不足以完全确保变量就是目标类型。
例如，其他类型也可能具有相同的属性。为了更准确地判断类型，通常需要检查更多属性或者考虑使用自定义的类型保护函数。

__EOF__

本文作者：龙陌
本文链接：https://www.cnblogs.com/longmo666/p/18009958.html
关于博主：评论和私信会在第一时间回复。或者直接私信我。
版权声明：本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！
声援博主：如果您觉得文章对您有帮助，可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力！