【问题标题】:How can I require a specific combination of parameters (i.e. omit required alias names)?我如何需要特定的参数组合(即省略所需的别名)?
【发布时间】:2022-01-22 17:49:38
【问题描述】:

考虑到别名的满足,我有一个关于省略必需参数的问题。我知道这听起来很复杂,所以让我提供一个实际用例。

如果我们快速浏览一下“通用参数和类型”下的 Bing Maps API - REST 文档(可在此处找到:Bing Maps - Common Parameters and Types)

如果您快速浏览一下文档,您可能会注意到有一些“别名”参数名称。

为了便于解释,假设我们有一个坐标样式对象,它由纬度和经度组成。纬度和经度都有短别名——分别是“lat”和“lng”。我们如何才能创建足够聪明的类型来接受所需的组合,同时省略之前已经满足的多余参数?

type Latitude  = { latitude: number }  | { lat: number };
type Longitude = { longitude: number } | { lng: number };
type Location  = Latitude & Longitude;

function formatLocation(loc: Location) {
    //... Do something useful
}

formatLocation({
    lat: 123.456,
    latitude: 123.456, // <--- would like for this to be an error or omitted as "lat" is already satisfied.
    longitude: -12.3456
});

我知道有一种方法可以使用 TypeScript“高级类型”(特别是排除、提取、省略等)实现这种行为但是,有没有一种方法可以动态地实现这一点?

【问题讨论】:

  • 这里的“动态”是什么意思?你能举个例子说明什么是动态的,什么不是动态的?
  • 您好 jcalz,感谢您的回复。如果我不清楚我在这里使用“动态”,我很抱歉。我的意思是,如果我们事先知道将使用哪种组合(例如,长纬度、别名 lng 或别名纬度、别名经度),我们可以通过创建一个新类型(如 type current = Omit 有没有办法在飞行中实现这一目标?因此,动态?

标签: typescript


【解决方案1】:

我的倾向是创建一个名为 OmitSuperfluousProperties&lt;T&gt; 的类型函数,它将采用联合类型 T 并生成一个新联合,其中每个成员明确禁止其他成员使用额外的键。所以OmitSuperfluousProperties&lt;{a: string} | {b: number}&gt; 应该变成{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&lt;T&gt; 是一个条件类型,它采用联合类型T 并返回所有成员的完整键集。所以AllKeys&lt;{a: string} | {b: number}&gt; 是"a" | "b"。然后将其作为默认的第二个参数提供给OmitSuperfluousProperties&lt;T, K&gt;。对于T 的每个成员,我们将其与Partial&lt;Record&lt;Exclude&lt;K, keyof T&gt;, never&gt;&gt; 相交。在T 是{a: string} | {b: number} 并且K 是"a" | "b" 的情况下,这对于第一个成员变为{a: string} &amp; {b?: never},对于第二个成员变为{b: number} &amp; {a?: never}。最后,我使用conditional type inference 技巧将交叉点转换为单个对象类型,因此{a: string} &amp; {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

【讨论】:

  • jclalz,你是我的英雄!非常感谢您对我公认的利基/古怪问题的详细而简洁的回答。关于错误消息的有用性,我同意您的看法,但是,只有我在处理该项目。此外,这是一个比我最初设置的更优雅的解决方案(一个基于模板化对象合并参数的辅助类,该模板化对象从传入对象引用所需的和别名。这不是很有用,因为它必须在功能体)。您的方式具有提前捕捉输入的优势。谢谢! :)
猜你喜欢
  • 2021-07-09
  • 1970-01-01
  • 1970-01-01
  • 2023-02-08
  • 2022-12-01
  • 2013-03-13
  • 2022-08-09
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多