TypeScript interface with XOR, {bar:string} xor {can:number}
You can use union types along with the never
type to achieve this:
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
As proposed in this issue, you can use conditional types (introduced in Typescript 2.8) to write a XOR type:
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;
And you can use it like so:
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
You can get "one but not the other" with union and optional void type:
type IFoo = {bar: string; can?: void} | {bar?:void; can: number};
However, you have to use --strictNullChecks
to prevent having neither.