让函数返回用户定义的类型保护是不可能的吗？

Question

考虑以下类型和子类型：

interface Animal {
  type: string;
}

interface Dog extends Animal {
  type: 'dog';
  sound: 'bark';
}

interface Cat extends Animal {
  type: 'cat';
  purpose: 'world_domination';
}

还有一种方法可以从 type 的值中获取 Animal 子类型：

type Animals = Dog | Cat;
type AnimalFromType<T extends Animals['type']> = Extract<Animals, { type: T }>;

现在假设我有一个动物数组，我想创建 一个返回用户定义类型保护的函数，然后可以在 Array.filter() 调用中使用它：

function createFilter<T extends 'dog' | 'cat'>(type: T): (x: any) => x is AnimalFromType<T> {
  return x => x.type === type;
}

问题是函数似乎不可能返回类型保护函数 - 编译器向 TS2322 抱怨 (x: any) => boolean 不能分配给 (x: any) => x is AnimalFromType<T> - 签名必须是类型谓词。出于某种原因，编译器不理解从 lambda 返回的布尔表达式与外部函数签名的 x is AnimalFromType<T> 部分匹配。

这是为什么呢？什么会阻止编译器理解 createFilter('dog') 返回一个用户定义的类型保护（它接受一个对象并返回 x is Dog）？

编辑：@jcalz 在此处提供的完整 MRE：https://tsplay.dev/wX219m

Answer 1

权威答案请见microsoft/TypeScript#14826。

如果您希望编译器看到 boolean 值可分配给 type predicate，则需要将其用作函数的返回值，该函数的 return type is explicitly annotated 是该类型谓词。这是类型检查器唯一支持的方法。

用户定义的类型保护及其类型谓词不会在 TypeScript 中传播，因此您对“类型谓词的传递性”之类的任何直觉可能不会成功。所以你会得到这种行为：

function isString(x: any): x is string {
  return typeof x === "string"; // okay
}

function isStringMaker(): (x: any) => x is string {
  return (x: any) => typeof x === "string"; // error
}

因为函数(x: any) => typeof x === string 没有类型谓词类型的带注释的返回值。编译器只是为它推断(x: any) => boolean，然后一切都中断了。没有contextual typing 说“因为isStringMaker() 想要返回一个返回类型谓词的函数，我们应该尝试将typeof x === string 解释为这样一个类型谓词，因为它在相关位置。 "也许可以实现这样的事情，但事实并非如此，而且似乎这是设计要求围绕类型谓词进行非常本地和明确的意图表达。

要使用isStringMaker，我们可以注释返回的箭头函数的返回类型：

function isStringMaker(): (x: any) => x is string {
  return (x: any): x is string => typeof x === "string"; // okay
  // ----------> ^^^^^^^^^^^^^ <--- return type annotation
}

我可以在手册中找到任何明显的文档都没有记录，您可以通过这种方式注释箭头函数的返回类型，但在上面链接的 ms/TS#14826 中提到了它，因此您至少可以查阅它。无论如何，一旦你这样做了，你就不需要再注释 isStringMaker() 返回类型了，因为 将被推断出来......所以如果你关心冗余，你可以在那里消除它：

function isStringMaker() {
  return (x: any): x is string => typeof x === "string"; 
}

---

因此，我的建议是更改您的createFilter()，以便实际的类型保护函数具有返回类型注释：

function createFilter<T extends 'dog' | 'cat'>(type: T) {
  return (x: any): x is AnimalFromType<T> => x.type === type;
}

Playground link to code

Answer 2

也许一个简单的 instanceof 可以解决您的问题。您可以在数组过滤器中使用它：

animals.filter(animal => animal instanceof Dog )

我使用类来定义类型。

interface Animal {
  type: string;
  name: string;
}

class Cat implements Animal {
  type: string;
  name: string;
  purpose: string;

  constructor(name: string) {
    this.type = 'cat';
    this.name = name;
    this.purpose = 'world_domination';
  }
}

class Dog implements Animal {
  type: string;
  name: string;

  constructor(name: string) {
    this.type = 'dog';
    this.name = name;
    this.sound = 'bark';
  }
}

const animals = [ new Dog('dog0'), new Cat('cat0'), new Dog('dog1'), new Cat('cat1')]

console.log(animals.filter(animal => animal instanceof Dog ))