带XOR的TypeScript接口,{bar:string} xor {can:number}

时间:2017-06-08 01:43:30

标签: typescript interface schema xor typescript2.0

我怎么说我希望界面是一个或另一个,但不是两个或两者都没有?

interface IFoo {
    bar: string /*^XOR^*/ can: number;
}

4 个答案:

答案 0 :(得分:16)

您可以使用联合类型和never类型来实现此目的:

type IFoo = {
  bar: string; can?: never
} | {
    bar?: never; can: number
  };


let val0: IFoo = { bar: "hello" } // OK only bar
let val1: IFoo = { can: 22 } // OK only can
let val2: IFoo = { bar: "hello",  can: 22 } // Error foo and can
let val3: IFoo = {  } // Error neither foo or can

答案 1 :(得分:5)

根据this issue中的建议,您可以使用conditional types (introduced in Typescript 2.8)来编写XOR类型:

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;

您可以像这样使用它:

type IFoo = XOR<{bar: string;}, {can: number}>;
let test: IFoo;
test = { bar: "test" } // OK
test = { can: 1 } // OK
test = { bar: "test",  can: 1 } // Error
test = {} // Error

答案 2 :(得分:3)

你可以得到一个而不是另一个&#34;使用union和可选void type

type IFoo = {bar: string; can?: void} | {bar?:void; can: number};

但是,您必须使用--strictNullChecks来防止两者都没有。

答案 3 :(得分:1)

试试这个:

type Foo = {
    bar?: void;
    foo: string;
}

type Bar = {
    foo?: void;
    bar: number;
}

type FooBar = Foo | Bar;

// Error: Type 'string' is not assignable to type 'void'
let foobar: FooBar = {
    foo: "1",
    bar: 1
}

// no errors
let foo = {
    foo: "1"
}