TypeScript 获取函数的参数类型、返回值类型

4,728次阅读
2 条评论

共计 806 个字符,预计需要花费 3 分钟才能阅读完成。

提醒:本文最后更新于2025-07-07 14:43,文中所关联的信息可能已发生改变,请知悉!

在使用 TypeScript 开发的过程中,类型定义是一个必要但又繁琐的过程。

当需要对一个第三方库方法的入参进行单独定义,而该库又没有导出该方法的入参类型时,就需要获取该方法的入参类型。

例如,有如下示例函数,我们想获取其参数类型和返回值类型,那么具体应该如何实现呢。

示例函数:

function test(lzwme: string, idx: number) {
return {
lzwme,
idx,
};
}

1 获取函数的参数类型

使用预定义的 Parameters 可以获取到一个函数的参数类型列表。

获取 test 函数的参数类型:

type TestArgsType = Parameters<typeof test>;
// TestArgsType => [lzwme: string, idx: number]

获取 idx 参数的类型:

type TestArgsType = Parameters<typeof test>[1];
// TestArgsType => idx: number

我们看一下 Parameters 的定义:

type Parameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? P : never;

我们可以看到,其实它主要是通过 infer P 获取到 T 的参数类型列表 P 并返回,如果 T 不是函数则返回 never

2 获取函数的返回值类型

使用预定义的 ReturnType 可以获取到一个函数的参数类型列表。

获取 test 函数的返回值类型:

type TestReturnType = ReturnType<typeof test>;

我们再看一下 ReturnType 的定义:

type ReturnType<T extends (...args: any) => any> = T extends (...args: any) => infer R ? R : any;

Parameters 十分类似,不同的是通过 infer R 获取并返回 T 的返回值类型。

正文完
 0
任侠
版权声明:本站原创文章,由 任侠 于2020-11-17发表,共计806字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
评论(2 条评论)
验证码
王光卫博客 评论达人 LV.1
2020-12-10 21:53:57 回复
Firefox 83.0 Firefox 83.0 Mac OS X 10.16 Mac OS X 10.16

专研技术的大咖啊 :biggrin:

 Macintosh  Firefox  中国四川省成都市电信
老张博客 评论达人 LV.1
2020-11-27 17:17:12 回复
Microsoft Edge 87.0.664.47 Microsoft Edge 87.0.664.47 Windows 10 x64 Edition Windows 10 x64 Edition

博主你好,你的近期评论是用什么插件实现的?我的用了插件怎么不显示呢!
https://iboge.com

 Windows  Edge  中国江苏省宿迁市电信