New Type: AllUnionFields (similar to SharedUnionFields)
Type description + examples
Expand on SharedUnionFields with a type that keeps all the union fields.
This is a simplified version of #386.
This new type will simply change non-shared fields to optional with value unknown. Or with an option (proposed name exact), will be changed to be optional with a value of the union of all values for that property within the union.
Edit: This new type will change each field to be optional with a value of the union of all values for that property within the union.
Simple example by modifying the SharedUnionFields's example (probably not that great an example of why you'd actually want to use this type)
import type {AllUnionFields} from 'type-fest';
type Cat = {
name: string;
type: 'cat';
catType: string;
};
type Dog = {
name: string;
type: 'dog';
dogType: string;
};
function displayPetInfo(petInfo: Cat | Dog) {
// typeof petInfo =>
// {
// name: string;
// type: 'cat';
// catType: string;
// } | {
// name: string;
// type: 'dog';
// dogType: string;
// }
console.log('name: ', petInfo.name);
console.log('type: ', petInfo.type);
// TypeScript complains about `catType` and `dogType` not existing on type `Cat | Dog`.
console.log('animal type: ', petInfo.catType ?? petInfo.dogType);
}
function displayPetInfo(petInfo: AllUnionFields<Cat | Dog>) {
// typeof petInfo =>
// {
// name: string;
// type: 'cat' | 'dog';
// catType?: string;
// dogType?: string;
// }
console.log('name: ', petInfo.name);
console.log('type: ', petInfo.type);
// No TypeScript error.
console.log('animal type: ', petInfo.catType ?? petInfo.dogType);
}Type source
No response
Search existing types and issues first
- I tried my best to look for it
sindresorhus / type-fest
A collection of essential TypeScript types
14.5k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too