传递给函数时，Typescript缩小对象中的键

Question

为什么 TypeScript 不将对象成员的类型缩小应用于对象类型本身，以便可以将其传递给另一个需要缩小类型的函数？如何在不失去类型安全的情况下修复/规避这个问题？

小例子：

type A = { key: string | null};
type B = {key: string};

function func(a: B) {};

const a: A = {key:'abcd'};
if(typeof(a.key)==='string') {
  a.key // has (narrowed) type 'string'
  func(a); // still does not work
}

错误信息是：Types of property 'key' are incompatible. Type 'string | null' is not assignable to type 'string'.

Playground-Link

Answer 1

如果您想根据给定类型缩小对象的任何属性，该怎么办？ @gwin-pin 有首发，但这里是：

const isValidPropType = <T extends Record<P, T[P]>, P extends keyof T, Z extends T[P]>(
  object: T,
  prop: P,
  typeofParam: Z
): object is T & Record<P, Z> => {
  return typeof object[prop] === typeof typeofParam;
};

TS Playground 使用原始问题。

Answer 2

我很好奇并找到了如何缩小对象属性的方法。它并没有精确到 B 型，但是 Typescript 是一种具有结构类型的语言，因此该解决方案就像一个魅力。

const isPropString = <P extends string, T extends Record<P, T[P]>>(
    prop: P,
    object: T,
): object is T & Record<P, string> => {
    return typeof object[prop] === 'string';
};

Answer 3

使用类型保护：https://www.typescriptlang.org/docs/handbook/advanced-types.html#typeof-type-guards

type A = { key: string | null};
type B = {key: string};

function func(a: B) {};

const a: A = {key:'abcd'};

const isB = (foo: A | B): foo is B => typeof a.key === "string";
if(isB(a)) {
  a.key
  func(a);
}

TS Playground

Answer 4

这最终是design limitation of TypeScript。它does not use type guards on an object's properties to narrow the object itself，除非在对象是discriminated union 类型的特殊情况下......而在你的情况下，A 根本不是联合，更不用说有区别的联合了。

我为您的情况执行此操作的方法是引入一个 user-defined type guard function，它显式执行您期望的缩小：您传入一个具有 key 属性的对象，并返回 true 或 false，具体取决于关于这个对象是否是一个有效的B：

const isB = (x: { key: any }): x is B => typeof x.key === "string";

那你就用它吧：

if (isB(a)) {
  func(a); // okay
}

这（给予或接受函数调用）本质上与您的代码逻辑相同，但编译器现在可以识别您的意图。好的，希望有帮助；祝你好运！

Link to code