请不要在TS中使用Function类型

在 TypeScript 中,避免使用 Function 作为类型。Function 代表的是"任意类型的函数",这会带来类型安全问题。对于绝大多数情况,你可能更希望明确地指定函数的参数和返回值类型。

如果你确实想表达一个可以接收任意数量参数并返回任意类型的函数,可以使用 (...args: any[]) => any 这种形式。它明确表示函数的参数是一个任意长度的数组,并且返回值的类型也是任意的,这样既保留了灵活性,也提供了足够的类型信息。

使用函数类型的案例

想象一下,你正在编写一个函数,用于对数组中的元素求和。这在 Excalidraw 代码库中有一个很好的例子:

typescript 复制代码
const sum = <T>(
  array: readonly T[],
  mapper: (item: T) => number
): number =>
  array.reduce(
    (acc, item) => acc + mapper(item),
    0
  );

这个 sum 函数的定义很简单,它接收两个参数:

  • array: 一个只读的泛型数组 readonly T[]
  • mapper: 一个将数组项映射为数字的函数 (item: T) => number

该函数最终返回一个 number,也就是数组中所有项通过 mapper 函数处理后的和。

mapper 函数的作用

mapper 函数是这个模式中的关键部分。让我们单独看看 mapper 的定义:

typescript 复制代码
type Mapper<T> = (item: T) => number;

mapper 的类型声明表示,它接收一个类型为 T 的参数,并返回一个数字。

假设你有一个 YouTube 视频对象的数组,你想统计所有视频的观看次数。这是一个可能的使用案例:

typescript 复制代码
interface YouTubeVideo {
  name: string;
  views: number;
}

const youTubeVideos: YouTubeVideo[] = [
  { name: "My favorite cheese", views: 100 },
  { name: "My second favorite cheese (you won't believe it)", views: 67 }
];

const mapper: Mapper<YouTubeVideo> = (video) => video.views;

const result = sum(youTubeVideos, mapper); // 167

在这个例子中,mapper 函数从每个 YouTubeVideo 对象中提取 views 属性,并将它们相加,最终得到了 167 这个总数。

类型推断的优势

TypeScript 的类型推断能力非常强大。在上面的例子中,即便你省略了显式的类型声明,TypeScript 依然可以根据上下文推断出正确的类型:

typescript 复制代码
const youTubeVideos = [
  { name: "My favorite cheese", views: 100 },
  { name: "My second favorite cheese (you won't believe it)", views: 67 }
];

const result = sum(youTubeVideos, (video) => video.views); // 167

虽然没有显式声明 youTubeVideos 的类型,但 TypeScript 仍然能够推断出 video 的类型是 { name: string; views: number }。这是因为我们在 sum 函数的定义中明确了 mapper 的函数签名 (item: T) => number,因此 TypeScript 可以自动推导出类型。

避免使用 Function 类型

在开发中,很多初学者会犯一个常见的错误:将函数类型声明为 Function。比如说,以下这种写法就存在问题:

typescript 复制代码
const sum = <T>(
  array: readonly T[],
  mapper: Function
): number =>
  array.reduce(
    (acc, item) => acc + mapper(item),
    0
  );

使用 Function 作为类型实际上是在告诉 TypeScript:mapper 可以是任何函数,这样的声明没有提供足够的类型约束,导致类型检查变得不那么严格。一个潜在的问题是,开发者可能会无意中传入不返回数字的函数:

typescript 复制代码
const result = sum(youTubeVideos, (item) => {
  return item.name;
});

在这个例子中,mapper 返回的是 name(字符串)而非 views(数字),但由于 Function 类型没有约束返回值类型,TypeScript 无法捕捉到这个错误。

更好的函数类型表达

如果你想要表达"任何函数",可以使用更具体的函数签名,而非 Function。例如,如果你想表示接收任意参数且返回任意值的函数,可以使用 (...args: any[]) => any 这样的形式。这个签名意味着函数可以接收任意数量的参数,并且可以返回任意类型的值。

TypeScript 还提供了一些内置的实用类型,如 ParametersReturnType,可以帮助你推断函数的参数和返回值类型:

typescript 复制代码
export type Parameters<
  T extends (...args: any) => any
> = T extends (...args: infer P) => any
  ? P
  : never;

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

Parameters<T> 可以获取函数 T 的参数类型,而 ReturnType<T> 则可以获取其返回值类型。这些实用类型都使用了 (...args: any) => any 作为约束,表示可以接收任意参数并返回任意类型的函数。

总结

在 TypeScript 中,尽量避免使用 Function 作为类型。它过于宽泛,会导致类型检查失效。通过使用 (a: string) => any(...args: any[]) => any 这样的具体类型签名,你可以在获得类型安全的同时保留代码的灵活性。

这不仅能帮助你捕捉潜在的类型错误,还能让你的代码在团队协作和项目维护中更加健壮。

相关推荐
活宝小娜41 分钟前
vue不刷新浏览器更新页面的方法
前端·javascript·vue.js
程序视点43 分钟前
【Vue3新工具】Pinia.js:提升开发效率,更轻量、更高效的状态管理方案!
前端·javascript·vue.js·typescript·vue·ecmascript
coldriversnow44 分钟前
在Vue中,vue document.onkeydown 无效
前端·javascript·vue.js
我开心就好o1 小时前
uniapp点左上角返回键, 重复来回跳转的问题 解决方案
前端·javascript·uni-app
开心工作室_kaic2 小时前
ssm161基于web的资源共享平台的共享与开发+jsp(论文+源码)_kaic
java·开发语言·前端
刚刚好ā2 小时前
js作用域超全介绍--全局作用域、局部作用、块级作用域
前端·javascript·vue.js·vue
沉默璇年3 小时前
react中useMemo的使用场景
前端·react.js·前端框架
yqcoder3 小时前
reactflow 中 useNodesState 模块作用
开发语言·前端·javascript
2401_882727573 小时前
BY组态-低代码web可视化组件
前端·后端·物联网·低代码·数学建模·前端框架
SoaringHeart4 小时前
Flutter进阶:基于 MLKit 的 OCR 文字识别
前端·flutter