我的倾向是创建一个名为 OmitSuperfluousProperties<T> 的类型函数,它将采用联合类型 T 并生成一个新联合,其中每个成员明确禁止其他成员使用额外的键。所以OmitSuperfluousProperties<{a: string} | {b: number}> 应该变成{a: string, b?: never} | {a?: never, b: number}。
这是一种可能的定义:
type OmitSuperfluousProperties<T, K extends PropertyKey = AllKeys<T>> =
T extends any ? (
T & Partial<Record<Exclude<K, keyof T>, never>>
) extends infer O ? { [P in keyof O]: O[P] } : never
: never;
type AllKeys<T> = T extends any ? keyof T : never;
在此我使用distributive conditional types 将T 拆分为其工会成员,对每个成员进行操作,然后将它们重新组合在一起。
AllKeys<T> 是一个条件类型,它采用联合类型T 并返回所有成员的完整键集。所以AllKeys<{a: string} | {b: number}> 是"a" | "b"。然后将其作为默认的第二个参数提供给OmitSuperfluousProperties<T, K>。对于T 的每个成员,我们将其与Partial<Record<Exclude<K, keyof T>, never>> 相交。在T 是{a: string} | {b: number} 并且K 是"a" | "b" 的情况下,这对于第一个成员变为{a: string} & {b?: never},对于第二个成员变为{b: number} & {a?: never}。最后,我使用conditional type inference 技巧将交叉点转换为单个对象类型,因此{a: string} & {b?: never} 成为等效且更易于查看的{a: string, b?: never}。
让我们试试吧:
type StrictLocation = OmitSuperfluousProperties<Location>
/* type StrictLocation = {
latitude: number;
longitude: number;
lng?: undefined;
lat?: undefined;
} | {
latitude: number;
lng: number;
longitude?: undefined;
lat?: undefined;
} | {
lat: number;
longitude: number;
latitude?: undefined;
lng?: undefined;
} | {
lat: number;
lng: number;
latitude?: undefined;
longitude?: undefined;
} */
这看起来像你想要的类型,对吧?我们可以检查:
formatLocation({
lat: 123.456,
longitude: -12.3456
}); // okay
formatLocation({
lat: 123.456,
latitude: 123.456,
longitude: -12.3456
}); // error!
/* Argument of type '{ lat: number; latitude: number; longitude: number; }'
is not assignable to parameter of type
'{ latitude: number; longitude: number; lng?: undefined; lat?: undefined; } |
{ latitude: number; lng: number; longitude?: undefined; lat?: undefined; } |
{ lat: number; longitude: number; latitude?: undefined; lng?: undefined; } |
{ ...; }'. */
好消息:如果同时指定 latitude 和 lat,则会出现错误。坏消息:如果你还不知道你在找什么,这个错误并不是特别有启发性。编译器看到传入的值不能分配给联合的四个成员中的任何一个,但它并不真正知道哪个失败是要告诉您的重要失败。一个人会说“你不能在这里同时使用latitude 和lat”,但编译器会说“你可能遗漏了lng”?如果你添加lng,那么它会说“哦,等等,其中一个应该是undefined,我认为”,这更接近有用,但仍然不是最佳的。哦,好吧,至少这是一个类型兼容性错误!
无论如何,希望对您有所帮助。祝你好运!
Playground link to code