Typescript 是否支持互斥类型？

Question

我有一个带参数的方法。我希望 Typescript 验证传入的对象（在 typescript 编译时，我理解运行时是另一种动物）只满足一个允许的接口。

例子：

interface Person {ethnicity: string;}
interface Pet {breed: string;}
function getOrigin(value: Person ^ Pet){...}

getOrigin({}); //Error
getOrigin({ethnicity: 'abc'}); //OK
getOrigin({breed: 'def'}); //OK
getOrigin({ethnicity: 'abc', breed: 'def'});//Error

我意识到 Person ^ Pet 不是有效的 Typescript，但这是我想尝试的第一件事，而且看起来很合理。

Answer 1

按照this issue 中的建议，您可以使用conditional types 编写异或类型：

type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;

现在你的例子有效了：

interface Person {ethnicity: string;}
interface Pet {breed: string;}
function getOrigin(value: XOR<Person, Pet>) { /* ... */}

getOrigin({}); //Error
getOrigin({ethnicity: 'abc'}); //OK
getOrigin({breed: 'def'}); //OK
getOrigin({ethnicity: 'abc', breed: 'def'});//Error

Answer 2

您可以使用专门用于解决此问题的小型 npm 包 ts-xor。

使用它，您可以执行以下操作：

import { XOR } from 'ts-xor'

interface A {
  a: string
}

interface B {
  b: string
}

let A_XOR_B: XOR<A, B>

A_XOR_B = { a: 'a' }          // OK
A_XOR_B = { b: 'b' }          // OK
A_XOR_B = { a: 'a', b: 'b' }  // fails
A_XOR_B = {}                  // fails

完全披露：我是这个小包的作者。我发现我需要一直实现从 repo-to-repo 的 XOR 类型。所以我为我和社区发布了它，这样我也可以使用自述文件和共享的 jsdoc 注释正确记录它。该实现是@Guilherme Agostinelli 从社区分享的内容。

Answer 3

为了补充 Nitzan 的答案，如果您真的想要强制指定 ethnicity 和 breed 相互排他，您可以使用映射类型来强制缺少某些字段：

type Not<T> = {
    [P in keyof T]?: void;
};
interface Person {ethnicity: string;}
interface Pet {breed: string;}
function getOrigin(value: Person & Not<Pet>): void;
function getOrigin(value: Pet & Not<Person>): void;
function getOrigin(value: Person | Pet) { }

getOrigin({}); //Error
getOrigin({ethnicity: 'abc'}); //OK
getOrigin({breed: 'def'}); //OK

var both = {ethnicity: 'abc', breed: 'def'};
getOrigin(both);//Error

Answer 4

你可以使用Discriminating Unions:

interface Person {
  readonly discriminator: "Person"
  ethnicity: string
}

interface Pet {
  readonly discriminator: "Pet"
  breed: string
}

function getOrigin(value: Person | Pet) { }

getOrigin({ }) // Error
getOrigin({ discriminator: "Person", ethnicity: "abc" }) // OK
getOrigin({ discriminator: "Pet", breed: "def"}) // OK
getOrigin({ discriminator: "Person", ethnicity: "abc", breed: "def"}) // Error

Answer 5

你可以使用union types:

function getOrigin(value: Person | Pet) { }

但最后一条语句不会出错：

getOrigin({ethnicity: 'abc', breed: 'def'}); // fine!

如果您希望这是一个错误，那么您需要使用 overloading:

function getOrigin(value: Pet);
function getOrigin(value: Person);
function getOrigin(value: Person | Pet) {}