从可区分联合数组中查找的窄返回类型

Question

我经常使用下面示例中的代码，想知道是否有一些聪明的方法可以键入 find 结果而无需进行显式类型断言。

type Foo = { type: "Foo" };
type Goo = { type: "Goo" };
type Union = Foo | Goo;

const arr: Union[] = [];
const foo = arr.find(a => a.type === "Foo") as Foo;

如果省略as Foo 类型断言，则结果为Union 类型，即使它只能返回Foo 类型。

在此类示例中，修复 find 类型以返回缩小类型的最简洁方法是什么？

编辑：这个问题也可能适用于filter 和其他类似的方法。

Edit2：建议的类似问题的接受答案 (Way to tell TypeScript compiler Array.prototype.filter removes certain types from an array?) 表明，通过在 find/filter 的谓词中使用类型保护，可以缩小返回值。

这种类型保护函数应该如何缩小任何有区别的联合，例如区分字符串文字总是在type 键下？

Answer 1

感谢 jcalz the excellent accepted answer。

我为谓词守卫注释了一个略有不同的工厂风格：

function hasProp<K extends PropertyKey, V extends string | number | boolean>(k: K, v: V) {
  
  // All candidate types might have key `K` of any type
  type Candidate = Partial<Record<K, any>> | null | undefined

  // All matching subtypes of T must have key `K` equal value `V`
  type Match<T extends Candidate> = Extract<T, Record<K, V>>

  return <T extends Candidate>(obj: T): obj is Match<T> => (
    obj?.[k] === v
  )
}

Answer 2

公认的答案很好，但很难理解。我带着这样的东西去了。它的可重用性较低，仅适用于一种类型，但更容易阅读。

function isType<V extends Union['type']>(val: V) {
  return (obj: Union):
      obj is Extract<Union, {type: V}> => obj.type === val;
}

const found = arr.find(isType('Foo'));

Answer 3

这是上面答案中 jcalz 的代码，用否定和联合进行了扩展。

export function isDiscriminate<K extends PropertyKey, V extends string | number | boolean>(
    discriminantKey: K, discriminantValue: V | V[]
) {
    return <T extends Record<K, any>>(
        obj: T & Record<K, V extends T[K] ? T[K] : V>
    ): obj is Extract<T, Record<K, V>> =>
        Array.isArray(discriminantValue) 
            ? discriminantValue.some(v => obj[discriminantKey] === v)
            : obj[discriminantKey] === discriminantValue;
}

export function isNotDiscriminate<K extends PropertyKey, V extends string | number | boolean>(
    discriminantKey: K, discriminantValue: V | V[]
) {
    return <T extends Record<K, any>>(
        obj: T & Record<K, V extends T[K] ? T[K] : V>
    ): obj is Exclude<T, Record<K, V>> =>
        Array.isArray(discriminantValue)
            ? discriminantValue.some(v => obj[discriminantKey] === v)
            : obj[discriminantKey] === discriminantValue;
}

及用法：

type A = { type: "A" };
type B = { type: "B" };
type C = { type: "C" };
type Union = A | B | C;

const arr: Union[] = [];
arr.find(isDiscriminate("type", "A")); // A
arr.find(isDiscriminate("type", ["A", "B"])); // A | B
arr.find(isNotDiscriminate("type", "A")); // B | C
arr.find(isNotDiscriminate("type", ["A", "B"])) // C

Answer 4

如果你想要一个用户定义的类型保护函数的生成器，它返回一个类型谓词来区分有区别的联合，它可能看起来像这样：

function discriminate<K extends PropertyKey, V extends string | number | boolean>(
    discriminantKey: K, discriminantValue: V
) {
    return <T extends Record<K, any>>(
        obj: T & Record<K, V extends T[K] ? T[K] : V>
    ): obj is Extract<T, Record<K, V>> =>
        obj[discriminantKey] === discriminantValue;
}

如果我调用discriminate("type", "Foo")，结果是一个签名类似于<T>(obj: T)=>obj is Extract<T, {type: "Foo"}> 的函数。 （我说它是相似，因为实际的返回值将T 限制为仅使用"type" 作为键和可以分配"Foo" 的值。）让我们看看它是如何工作的：

const foo = arr.find(discriminate("type", "Foo")); // Foo | undefined 
const goos = arr.filter(discriminate("type", "Goo"));  // Goo[]

看起来不错。如果您传递不适用的字段/值，会发生以下情况：

const mistake1 = arr.find(discriminate("hype", "Foo")); // error!
// ------------------->   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Union is not assignable to Record<"hype", any>.
const mistake2 = arr.find(discriminate("type", "Hoo")); // error!
// ------------------->   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Union is not assignable to ((Foo | Goo) & Record<"type", "Hoo">)

好的，希望对您有所帮助；祝你好运！

Link to code