在打字稿中注释高阶函数

时间:2019-10-02 22:24:33

标签: typescript higher-order-functions

我正在使用一个相当大的JS代码库,试图将其迁移到Typescript并遇到注释特定的高阶函数的问题...

doStuff()接受fn1作为参数并包装它,返回一个新函数,该函数接受fn1的所有参数,但第一个参数除外。像这样:

const fn1 = (arg_1, arg_2, arg_3, arg_n) => { return 'Hello World' }

const doStuff = (fn) => (...args) => {
    argument1 = getSomeStuffHere()
    return fn(argument1, ...args)
}

const test = doStuff(fn1)
let result = test('arg2', 'arg3', 'arg4')

值得指出的是,这里有一个doStuff()fnX()个函数,其中包含许多数量的各种类型组合的参数。正确键入由doStuff创建的函数很重要,“ any => any”将不起作用!

经过一番混乱之后,我终于想到了:

// just for testing simplified example
type MagicObj = {}
const myMagicObject = {}

type Wrapped<T, R> =
    T extends [MagicObj, any, any, any, any] ? (a: T[1], b: T[2], c: T[3], d: T[4]) => R :
    T extends [MagicObj, any, any, any] ? (a: T[1], b: T[2], c: T[3]) => R :
    T extends [MagicObj, any, any] ? (a: T[1], b: T[2]) => R :
    T extends [MagicObj, any] ? (a: T[1]) => R :
    T extends [MagicObj] ? () => R :
    unknown;

const doStuff = <T extends any[], R>(fn: (...args: T) => R): Wrapped<T, R> => (...args) => fn(myMagicObject, ...args)

// testing examples
const fn1 = (obj: MagicObj, p1: string, p2: boolean, p3: number): string => { return 'Hello World' }
const fn2 = (obj: MagicObj, p1: number, p2: string) => { return 'Hello Mars' }
const fn3 = (obj: MagicObj, p1: boolean) => { return 'Hello The Moon' }

const test1 = doStuff(fn1)
// const test1: (a: string, b: boolean, c: number) => string 
let result1 = test1('str', true, 123) 

const test2 = doStuff(fn2)
// const test2: (a: number, b: string) => string
let result2 = test2(123, 'str')

const test3 = doStuff(fn3)
// const test3: (a: boolean) => string
let result3 = test3(true)

这似乎是一种工作。 VSCodes类型提示智能感知巫术在示例底部显示了我对test1、2、3和结果变量的期望/期望,但是无论如何尝试注解doStuff (...args) => fn(myMagicObject, ...args)返回的函数它报告Type '(...args: any[]) => any' is not assignable to type 'Wrapped<T, R>'.ts(2322)

的错误

有什么想法可以做到吗?

1 个答案:

答案 0 :(得分:2)

如果我了解您要执行的操作,则可以这样输入doStuff()

const doStuff = <T extends any[], R>(
  fn: (magicObject: MagicObj, ...args: T) => R
): ((...args: T) => R) => (...args) => fn(myMagicObject, ...args);

这表示从第一个参数类型为MagicObj的任何函数到相同类型但删除了MagicObj参数的另一个函数的转换。通过使用rest tuples,它应该适用于任意数量的参数。

这对您有用吗?好的,希望对您有所帮助。祝你好运!

Link to code