如何让TypeScript对JSX属性中不匹配的函数定义发出警告
让TS对JSX属性的函数参数不匹配场景发出警告的方法

为什么TS默认不对这类场景报错
TS的函数类型兼容性规则是为了贴合JS运行时的固有行为设计的:
- 调用函数时多传入的参数会被自动忽略,不会触发运行时错误
- 只要传入的函数的参数数量小于等于目标类型要求的参数数量,TS就会判定为类型兼容
以你提供的onConfirmRebuild实现为例,这个函数没有声明任何入参,当组件属性要求传入带布尔参数的函数时,TS会自动判定为类型合法,不会抛出警告:
async function onConfirmRebuild() { // need only the selected collection names const collectionNames = gridData.filter((c) => c.selected).map((c) => c.name); // need only the selected box ids const boxIds = boxes .filter((b) => collectionNames.some((name) => name == b.collectionIdentifier)) .map((box) => box.id); const success = await BoxAttributeApi.rebuild(auth, boxIds, false); setShowRebuildPrompt(false); if (success == false) { alert("Failed to submit attribute rebuild request"); } }
这种设计本意是兼容JS生态中常见的简化回调写法,比如数组map方法要求3个回调参数,绝大多数开发者只会写接收1个参数的回调,TS如果对这类场景强制报错,会完全破坏现有开发体验。
实现目标警告的具体方案
1. 开启TS严格函数类型检查
在tsconfig.json中开启strictFunctionTypes配置(如果开启了全局strict模式,该配置默认是开启状态):
- 该配置会对非方法形式的函数属性做严格的逆变检查
- 可以拦截绝大多数函数参数类型不匹配的问题,但依然不会禁止“参数数量更少的函数赋值给参数更多的函数类型”的写法
2. 使用自定义类型工具强制参数数量完全匹配
TS内置规则无法全局禁止少参数函数的兼容写法,但可以通过自定义类型工具,针对特定组件Props的函数属性做严格校验:
- 先定义用于强制匹配参数数量的工具类型:
type ExactFunction<T extends (...args: any[]) => any> = T extends (...args: Parameters<T>) => ReturnType<T> ? T : never; - 在定义组件Props时,将需要严格校验的函数属性用该工具包裹:
这种配置下,如果传入的type RebuildPromptProps = { onConfirmRebuild: ExactFunction<(value: boolean) => void> }onConfirmRebuild是无参数的函数,TS会直接抛出类型不匹配的警告,因为传入函数的参数数量和声明要求的参数数量无法对齐。
3. 配合ESLint做全局检查
如果不想逐个组件修改Props类型,可以借助ESLint的代码规则,在代码检查阶段拦截这类JSX中函数属性参数数量不匹配的场景,无需改动现有业务代码。
内容的提问来源于stack exchange,提问作者Ryan
相关产品推荐
相关产品推荐

