带重载函数的类型推断

时间:2018-08-02 10:12:35

标签: typescript

考虑以下重载函数:

function foo(arg1: string, cb: (err: Error|null, res: string) => void): void
function foo(arg1: string, arg2: string, cb: (err: Error|null, res: string) => void): void

我希望promisify使用此类功能。但是默认实现会返回无效的类型。

返回时

(arg1: string, arg2: string) => Promise<{}>

我希望它会返回

{
   (arg1: string): Promise<string>;
   (arg1: string, arg2: string): Promise<string>;
}

考虑到这一点,我想修复打字。我设法使用以下方法覆盖了该特定原型:

export type Callback<T> = (err: Error | null, reply: T) => void;
export type Promisify<T> =

    T extends {
        (arg1: infer T1, cb?:  Callback<infer U>): void;
        (arg1: infer P1, arg2: infer P2, cb?:  Callback<infer U2>): void;
    } ? {
        (arg1: T1): Promise<U>;
        (arg1: P1, arg2: P2): Promise<U2>;
    } :

    T extends (cb?:  Callback<infer U>) => void ? () => Promise<U> :
    T extends (arg1: infer T1, cb?:  Callback<infer P>) => void ? (arg1: T1) => Promise<P> :
    T extends (arg1: infer T1, arg2: infer T2, cb?:  Callback<infer U>) => void ? (arg1: T1, arg2: T2) => Promise<U> :
    T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, cb?:  Callback<infer U>) => void ? (arg1: T1, arg2: T2, arg3: T3) => Promise<U> :
    T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, cb?:  Callback<infer U>) => void ? (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<U> :
    T;

但是它要求我具体列出所有可能的方法重载。

有一种方法可以一次转换所有方法的重载,类似于我们可以转换对象属性的方式吗?

1 个答案:

答案 0 :(得分:10)

我们可以使用Tuples in rest parameters and spread expressions的3.0功能来获取重载参数的并集,但是我们需要为函数具有的每个重载次数添加一个大小写:

export type GetOverloadArgs<T> = 
    T extends { (...o: infer U) : void, (...o: infer U2) : void, (...o: infer U3) : void   } ? U | U2 | U3:
    T extends { (...o: infer U) : void, (...o: infer U2) : void  } ? U | U2 :
    T extends { (...o: infer U) : void } ? U : never

例如foo

type fooParams = GetOverloadArgs<typeof foo> 
// will be 
type fooParams = [string, (err: Error | null, res: string) => void] | [string, string, (err: Error | null, res: string) => void]

由此,我们可以使用类似于您的Promisify的类型为联合中的每个参数集创建函数:

export type PromisifyOne<T extends any[]> =
    T extends [Callback<infer U>?] ? () => Promise<U> :
    T extends [infer T1, Callback<infer P>] ? (arg1: T1) => Promise<P> :
    T extends [infer T1, infer T2, Callback<infer U>?] ? (arg1: T1, arg2: T2) => Promise<U> :
    T extends [infer T1, infer T2, infer T3, Callback<infer U>?]? (arg1: T1, arg2: T2, arg3: T3) => Promise<U> :
    T extends [infer T1, infer T2, infer T3, infer T4, Callback<infer U>?] ? (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<U> :
    T;

使用条件类型的分布行为,我们可以创建所有重载的并集:

export type Promisify<T> =PromisifyOne<GetOverloadArgs<T>> 
export type Promisify<T> =PromisifyOne<GetOverloadArgs<T>> 
type fooOverloadUnion = Promisify<typeof foo>
// Same as 
type fooOverloadUnion = ((arg1: string) => Promise<string>) | ((arg1: string, arg2: string) => Promise<string>)

要再次调用此函数,我们可以使用UnionToIntersection将并集转换为交集,最终结果是:

export type Callback<T> = (err: Error | null, reply: T) => void;
export type PromisifyOne<T extends any[]> =
    T extends [Callback<infer U>?] ? () => Promise<U> :
    T extends [infer T1, Callback<infer P>?] ? (arg1: T1) => Promise<P> :
    T extends [infer T1, infer T2, Callback<infer U>?] ? (arg1: T1, arg2: T2) => Promise<U> :
    T extends [infer T1, infer T2, infer T3, Callback<infer U>?]? (arg1: T1, arg2: T2, arg3: T3) => Promise<U> :
    T extends [infer T1, infer T2, infer T3, infer T4, Callback<infer U>?] ? (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<U> :
    T;

export type GetOverloadArgs<T> = 
    T extends { (...o: infer U) : void, (...o: infer U2) : void, (...o: infer U3) : void   } ? U | U2 | U3:
    T extends { (...o: infer U) : void, (...o: infer U2) : void  } ? U | U2 :
    T extends { (...o: infer U) : void } ? U : never

type UnionToIntersection<U> = (U extends any ? (k: U)=>void : never) extends ((k: infer I)=>void) ? I : never
export type Promisify<T> =  UnionToIntersection<PromisifyOne<GetOverloadArgs<T>>>

// Sample
declare function foo(arg1: string, cb: (err: Error|null, res: string) => void): void
declare function foo(arg1: string, arg2: string, cb: (err: Error|null, res: string) => void): void

declare const  fooPromise: Promisify<typeof foo>
let r = fooPromise("")
let r2 = fooPromise("", "")