如何在不使用自定义类型守卫时动态检查TypeScript对象是否含指定键

当键是字符串字面量时，我们可以用TypeScript的in关键字实现类型安全的对象键检查：

function guardHasTest<Data extends object>(value: Data): Data & Record<'test', unknown> {
  if (!('test' in value)) {
    throw new Error('Missing key')
  }
  return value
}

但如果将键设为动态字符串，同样的语法无法实现类型收窄，会出现类型错误：

function guardHasKey<Data extends object, Key extends string>(
  value: Data,
  key: Key
): Data & Record<Key, unknown> {
  if (!(key in value)) {
    throw new Error('Missing key')
  }
  return value
  // 类型错误：Type 'Data' is not assignable to type 'Data & Record<Key, unknown>'.
}

我不想用自定义类型守卫，因为这种写法逻辑可以完全不正确但不会报错，类型安全性无法保障：

export function isKeyOf<T, const Key extends string>(
  obj: T,
  key: Key
): obj is T & Record<Key, unknown> {
  return true // 逻辑错误但无类型报错
}

解决方案：使用断言函数（Assertion Functions） #

可以借助TypeScript的断言函数来实现，这种方式既能保证类型收窄，又能强制逻辑正确性：

function assertHasKey<Data extends object, Key extends string>(
  value: Data,
  key: Key
): asserts value is Data & Record<Key, unknown> {
  if (!(key in value)) {
    throw new Error(`Missing required key: ${key}`)
  }
}

// 使用示例
const obj = { name: 'Alice' }
assertHasKey(obj, 'age') // 运行时抛出错误
assertHasKey(obj, 'name') // 无错误，此时obj类型被收窄为 { name: string } & Record<'name', unknown>

断言函数通过asserts value is ...语法，告诉TypeScript：只要函数正常返回（不抛出错误），那么value的类型就符合断言的类型。这种写法的优势在于：

• 类型收窄完全由TypeScript自动处理，无需手动类型断言
• 必须编写正确的检查逻辑（否则运行时会报错），避免了自定义类型守卫的逻辑漏洞

另一种更简洁的写法是直接在函数中返回类型断言后的对象，但要确保检查逻辑正确：

function guardHasKey<Data extends object, Key extends string>(
  value: Data,
  key: Key
): Data & Record<Key, unknown> {
  if (!(key in value)) {
    throw new Error(`Missing key: ${key}`)
  }
  return value as Data & Record<Key, unknown>
}

这种写法通过as进行类型断言，但要注意必须保证in检查的逻辑正确，否则会导致类型不匹配的运行时问题。

内容的提问来源于stack exchange，提问作者David Y. Stephenson