TypeScript环境下react-formal搭配yup出现ObjectSchema类型缺失属性报错
类型报错根因
这个报错是跨版本依赖的类型定义不兼容导致的,核心触发点有两个:
- 当前使用的
react-formal@2.1.3版本,其内部Form组件的schemaprop类型定义,完全是基于yup@0.27.x版本的API结构编写的。yup 0.27.x的ObjectSchema是双泛型参数的结构,类型定义里要求Schema实例必须包含unknown、snakeCase、defined、optional等方法属性。 - 你实际安装的
yup@0.28.3对类型定义做了破坏性调整:一方面把ObjectSchema改成了单泛型参数结构,另一方面新增的方法属性也和0.27.x的类型结构不兼容。
TS基于结构类型做校验时,会把两个来自不同yup大版本的ObjectSchema判定为完全无关的类型:react-formal期待的是双泛型版本的Schema结构,你传入的是单泛型版本的实例,虽然运行时这个实例完全可以被正常解析,但TS会因为两者的类型结构不对等,抛出“缺少必需属性”的TS2740错误。
可落地解决办法
按照改动成本从低到高,有三种可选项:
1. 对齐yup版本到兼容范围
直接将yup降级到react-formal 2.1.3官方适配的yup@0.27.0,两者的类型定义完全匹配,不需要改任何业务代码。
- 安装命令示例:
npm install yup@0.27.0 - 安装完成后在VS Code命令面板执行
TypeScript: Restart TS Server,清除本地类型缓存即可生效。
2. 临时类型断言兜底
如果项目因为其他依赖要求必须保留yup@0.28.3,不需要修改任何运行时逻辑,只需要在传入schema prop的位置加类型断言绕开类型校验即可——运行时的Schema实例完全可以被react-formal正常解析,不存在实际功能问题。
调整后的代码示例:
import React from 'react'; import * as yup from 'yup'; import { ObjectSchema } from 'yup'; import Form from 'react-formal'; interface ITest { name: string; } const FormalTest: React.FC = () => { const schema: ObjectSchema<ITest> = yup.object<ITest>( { name: yup.string().required().default( 'default' ), } ); return ( <div> {/* 仅通过类型断言绕开版本不匹配的校验,不影响运行逻辑 */} <Form schema={schema as any} defaultValue={schema.default()} > <Form.Field name="name" /> </Form> </div> ); };
如果担心as any过于宽泛,可以替换为精准的结构断言,效果完全一致。
3. 全局覆写react-formal的类型定义
如果项目里多处用到Form组件,不想在每个位置重复写类型断言,可以在项目全局类型声明文件里覆写Form组件的props类型,让它兼容新版yup的Schema结构。
在项目的.d.ts声明文件中补充如下代码:
declare module 'react-formal' { interface FormProps { schema: import('yup').AnySchema; } }
这种方式可以全局消除所有同类型的报错,不需要修改业务组件的代码。
内容的提问来源于stack exchange,提问作者Marcin Kapusta
相关产品推荐
相关产品推荐

