TypeScript `infer` 关键字

<table class="d-block"> <tbody class="d-block"> <tr class="d-block"> <td class="d-block comment-body markdown-body js-comment-body"> 考察如下类型： <div class="highlight highlight-source-ts"><pre>type PromiseType<T> = (args: any\[\]) => Promise<T>;</pre></div> 那么对于符合上面类型的一个方法，如何得知其 Promise 返回的类型？ 譬如对于这么一个返回 <code>string</code> 类型的 Promise: <div class="highlight highlight-source-ts"><pre>async function stringPromise() { return "string promise"; }</pre></div> <h2><code>RetrunType</code></h2> 如果你对 TypeScript 不是那么陌生，可能知道官方类型库中提供了 <code>RetrunType</code> 可获取方法的返回类型，其用法如下： <div class="highlight highlight-source-ts"><pre>type stringPromiseReturnType = ReturnType<typeof stringPromise>; // Promise<string></pre></div> 确实拿到了方法的返回类型，不过是 <code>Promise<string></code>。但其实是想要返回里面的 <code>string</code>，所以和我们想要的还差点意思。 既然都能从一个方法反解其返回类型，肯定还能从 <code>Promsie<T></code> 中反解出 <code>T</code>。所以不不妨看看 <code>ReturnType</code> 的定义： <div class="highlight highlight-source-ts"><pre>/\*\* \* Obtain the return type of a function type \*/ type ReturnType<T extends (...args: any) => any> = T extends (...args: any) => infer R ? R : any;</pre></div> <kbd>F12</kbd> 一看，果然发现了点什么，这里使用了 <code>infer</code> 关键字。 <h2>条件类型及 <code>infer</code></h2> 上面 <code>T extends U ? X : Y</code> 的形式为条件类型（Conditional Types），即，如果类型 <code>T</code> 能够赋值给类型 <code>U</code>，那么该表达式返回类型 <code>X</code>，否则返回类型 <code>Y</code>。 所以，考察 <code>ReturnType</code>的定义， <div class="highlight highlight-source-ts"><pre>type ReturnType<T extends (...args: any) => any> = T extends (...args: any) => infer R ? R : any;</pre></div> 如果传入的类型 <code>T</code> 能够赋值给 <code>(...args: any) => R</code> 则返回类型 <code>R</code>。 但是这里类型 <code>R</code> 从何而来？讲道理，泛型中的变量需要外部指定，即 <code>RetrunType<T,R></code>，但我们不是要得到 R 么，所以不能声明在这其中。这里 <code>infer</code> 便解决了这个问题。表达式右边的类型中，加上 <code>infer</code> 前缀我们便得到了反解出的类型变量 <code>R</code>，配合 <code>extends</code> 条件类型，可得到这个反解出的类型 <code>R</code>。这里 <code>R</code> 即为函数 <code>(...args: any) => R</code> 的返回类型。 <h2>反解 Promise</h2> 有了上面的基础，推而广之就很好反解 <code>Promise<T></code> 中的 <code>T</code> 了。 <div class="highlight highlight-source-ts"><pre>type PromiseType<T> = (args: any\[\]) => Promise<T>;

type UnPromisify<T> = T extends PromiseType<infer U> ? U : never;</pre></div>

测试 <code>UnPromisify<T></code>： <div class="highlight highlight-source-ts"><pre>async function stringPromise() { return "string promise"; }

async function numberPromise() { return 1; }

interface Person { name: string; age: number; }

async function personPromise() { return { name: "Wayou", age: 999 } as Person; }

type extractStringPromise = UnPromisify<typeof stringPromise>; // string

type extractNumberPromise = UnPromisify<typeof numberPromise>; // number

type extractPersonPromise = UnPromisify<typeof personPromise>; // Person</pre></div>

<h2>解析参数数组的类型</h2> 反解还可用在其他很多场景，比如解析函数入参的类型。 <div class="highlight highlight-source-ts"><pre>type VariadicFn<A extends any\[\]> = (...args: A) => any; type ArgsType<T> = T extends VariadicFn<infer A> ? A : never;

type Fn = (a: number, b: string) => string; type Fn2Args = ArgsType<Fn>; // [number, string]</pre></div>

<h2>另一个示例</h2> 假设我们编写了两个按钮组件，底层渲染的是 HTML 原生的 <code>button</code> 和 <code>a</code> 标签。为了组件最大化可定制，原生元素支持的属性该组件也需要支持，因此可这样来写组件的 props: <div class="highlight highlight-source-tsx"><pre>type ButtonProps = { color: string; children: React.ReactChildren; } & React.DetailedHTMLProps< React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement >;

type AnchorButtonProps = { color: string; disabled: boolean; children: React.ReactChildren; } & React.DetailedHTMLProps< React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement >;

export function Button({ children, ...props }: ButtonProps) { //... return <button {...props}>{children}</button>; }

export function AnchorButton({ children, ...props }: AnchorButtonProps) { //... return <a {...props}>{children}</a>; }</pre></div>

单看 <code>Button</code> 和 <code>AnchorButton</code> 的属性， <div class="highlight highlight-source-ts"><pre>type ButtonProps = { color: string; children: React.ReactChildren; } & React.DetailedHTMLProps< React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement >;

不难看出两者是有共性的，即可抽取成如下的形式： <div class="highlight highlight-source-ts"><pre>type ExtendHTMLAttributes<P, T, K> = P & React.DetailedHTMLProps<T, K>;</pre></div> 其中 <code>T</code> 呢又是 <code>T<K></code> 形式，即 <code>T</code> 中包含或有使用了 K。因此对使用者来说，如果传递了 <code>T<K></code> 形式，就没必要单独再传递一次 <code>K</code>，我们应该是能利用 <code>infer</code> 从 <code>T<K></code> 解析出 <code>K</code> 的。 <div class="highlight highlight-source-ts"><pre>T extends React.HtmlHTMLAttributes<infer K> ? K : HTMLElement</pre></div> 所以抽取出来两种组件 Props 可公用的一个类型如下： <div class="highlight highlight-source-ts"><pre>export type ExtendHTMLAttributes< /\*\* 组件自定义属性 \*/ P, /\*\* 原生 HTML 标签自有属性 \*/ T extends React.HtmlHTMLAttributes<HTMLElement> > = P & React.DetailedHTMLProps< T, T extends React.HtmlHTMLAttributes<infer K> ? K : HTMLElement >;</pre></div> 利用抽取的 <code>ExtendHTMLAttributes</code>，两种按钮的 Props 可重新书写成如下形式： <div class="highlight highlight-source-ts"><pre>type ButtonProps = ExtendHTMLAttributes< { color: string; children: React.ReactChildren; }, React.ButtonHTMLAttributes<HTMLButtonElement> >;

type AnchorButtonProps = ExtendHTMLAttributes< { color: string; disabled: boolean; children: React.ReactChildren; }, React.AnchorHTMLAttributes<HTMLAnchorElement> >;</pre></div>

去掉了两者重叠的部分，看起来简洁了一些。关键后续编写其他组件时，如果想支持原生 HTML 属性，直接复用这里的 <code>ExtendHTMLAttributes</code> 类型即可。 <h2>相关资源</h2> <ul> <li><a href="https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html" rel="nofollow">TypeScript 2.8 - Conditional Types</a></li> <li><a href="https://lorefnon.tech/2018/07/18/unwrapping-composite-types-in-typescript/" rel="nofollow">Unwrapping composite types in Typescript</a></li> </ul> </td> </tr> </tbody> </table>

TypeScript `infer` 关键字

评论区

相关推荐