Union types (Foo | Bar) inconsistently becomes Partial<Foo & Bar>
davidbarratt opened this issue · 13 comments
🔎 Search Terms
"union type partial", "type union narrowing"
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about Unions
⏯ Playground Link
💻 Code
interface Foo {
foo: string;
}
interface Bar {
bar: number;
zaz: string;
}
function baz(props: Foo | Bar ) {
if ("bar" in props) {
console.log(props.zaz);
} else {
console.log(props.foo);
}
}
baz({ foo: "test" }); // test
baz({ bar: 1234, zaz: "yuh" }); // yuh
// oops! you can pass a subset of "both" rather than "one or the other".
baz({ foo: "test", bar: 123 }); // undefined
baz({ foo: "test", zaz: "dsfdf1" }); // test🙁 Actual behavior
I was surprised that I would pass in an object that is neither Foo nor Bar and TypeScript didn't complain about. This caused a bug at runtime that it seems like TypeScript should have caught?
Interestingly, the function definition is well aware that only one or the other could be passed. I could not write a scenario where that wasn't the case, but calling the funciton is where this fails.
🙂 Expected behavior
I expected to be able to pass Foo or Bar but not both and certainly not neither.
Additional information about the issue
I couldn't find a previous version of TypeScript where this worked as I would expect it too. I was really wondering if I was doing something wrong or this was a well known issue, but I was struggling to find anything on the topic.
It looks like this also fails:
const data: Foo|Bar = {
foo: "test",
bar: 123,
};in which case data is neither Foo nor Bar but TypeScript doesn't complain about it.
You can see this with both of these that fail:
const data: Foo = {
foo: "test",
bar: 123,
};
const data: Bar = {
foo: "test",
bar: 123,
};I would think that if they fail seperately, a union should also fail?
TS is working as designed and you've run into a known inconsistency/unsoundness in the language.
#12936: object types in TS are not "exact" (e.g., the objects you don't like are both valid Foo objects)
#20863: excess property checks don't occur for non-discriminated unions
#34975: the in operator is intentionally unsound
See also the FAQ:
(Indirect) Excess Properties Are OK
What is structural typing?
If I'm understanding that correctly in these two failing cases:
baz({ foo: "test", bar: 123 }); // undefined
baz({ foo: "test", zaz: "dsfdf1" }); // testboth objects are Foo with a bar and zaz excess property respectively?
In that case, isn't it the narrowing that cannot be trusted since it shouldn't allow you to narrow it down to Bar in the function declaration since it could be Foo with an excess property?
In which case the only way to narrow it would be to eliminate Foo?
interface Foo {
foo: string;
jaz: number;
}
interface Bar {
bar: number;
zaz: string;
}
function baz(props: Foo | Bar ) {
if (!("foo" in props)) {
console.log(props.zaz);
}
else {
console.log(props.jaz);
}
}
baz({ bar: 123, jaz: 1234, foo: "blah" }); // 1234Ideally, I'd like user to specify one object or the other when calling the function and have it fail if it doesn't have all the properties of one of the objects. Is that even possible?
both objects are
Foowith abarandzazexcess property respectively?
That's correct. And excess property checks don't kick in as per #20863 (linked by jcalz already).
In that case, isn't it the narrowing that cannot be trusted since it shouldn't allow you to narrow it down to
Barin the function declaration since it could beFoowith an excess property?
jcalz already linked the relevant issue here too: #34975. The in operator is intentionally unsound. You either accept this, or check the entire structure of your object, or (IMO the best option) add a discriminator property to your types.
Ideally, I'd like user to specify one object or the other when calling the function and have it fail if it doesn't have all the properties of one of the objects. Is that even possible?
That's... how it works with the code you have already.
I think I found a solution:
interface Foo {
foo: string;
zaz?: never;
bar?: never;
}
interface Bar {
foo?: never;
bar: number;
zaz: string;
}
function baz(props: Foo | Bar ) {
if ("bar" in props) {
console.log(props.zaz);
} else {
console.log(props.foo);
}
}
baz({ foo: "test" }); // test
baz({ bar: 1234, zaz: "yuh" }); // yuh
// oops! you can pass a subset of "both" rather than "one or the other".
baz({ foo: "test", bar: 123 }); // FAILS
baz({ foo: "test", zaz: "dsfdf1" }); // FAILSIt might be helpful if the docs were updated with something like that. Like you can make your unions safer by specifying all the known properties of the other values.
I wouldn't call this a "solution", but rather a crude workaround / hack. This call is still legit and will blow up:
baz({ foo: "test", get bar(): never { throw 1 } , get zaz(): never { throw 1 } });A property typed never does not mean the property doesn't exist..
@MartinJohns Is there an issue for having a syntax for "property does not exist" ? That seems like less of a lift than #12936 right?
There is #55143.
@MartinJohns I think we've had this disagreement before about things like {bar?: never}. If the possibility of a getter that throws is something to worry about then you always have to worry about it because every type T is equivalent to T | never. I would just check typeof props.bar !== "undefined" (instead of using in, which I agree isn't the right check) and if it blows up there then I'm fine, right?
FWIW I find it rather unintuitive that Excess Property Checks occur, but not if the property just so happens to be part of another object in the union.
Take for instance this execution:
baz({ foo: "test", bar: 123 }); // undefined
baz({ foo: "test", saz: "test" }); // FAILWhy is it that excess checks just get disabled if the property happens to be bar? Clearly it's an excess property of Foo and TypeScript knows that and does it correctly when it's a different property name.
@jcalz I see, this is the same issue. My apologies, I was tripped up by some of the language used in the issue. Thank you for your help!