TypeScript-gränssnitt med XOR, {bar:string} xor {can:number}

Hur säger jag att jag vill att ett gränssnitt ska vara det ena eller det andra, men inte båda eller inget av dem?

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

Svar #1

Du kan använda unionstyper tillsammans med never-typen för att uppnå detta:

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

Svar #2

Som föreslaget i detta ärende kan du använda villkorliga typer (införda i Typescript 2.8) för att skriva en XOR-typ:

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;

Och du kan använda det så här:

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

Relaterade artiklar