首页
/ Yup项目中泛型数组返回类型推断问题的解决方案

Yup项目中泛型数组返回类型推断问题的解决方案

2025-05-08 10:59:08作者:卓艾滢Kingsley

在使用Yup进行表单验证时,开发者经常会遇到需要处理分页数据集合的情况。为了保持代码的DRY原则(Don't Repeat Yourself),通常会创建一个通用的分页Schema生成函数。然而,在使用TypeScript和Yup结合时,可能会遇到一个关于泛型数组返回类型推断的特定问题。

问题背景

当开发者尝试创建一个通用的分页Schema生成函数时,通常会这样定义:

const getPaginatedSchema = <T extends AnyObjectSchema>(entitySchema: T) => object({
    count: number().required(),
    items: array(entitySchema).required(),
    pagination: object({
        skip: number().min(0).integer().required(),
        limit: number().positive().integer().required(),
    }),
});

理想情况下,我们希望items字段的类型能够正确推断为T[],即传入的实体Schema类型的数组。然而实际上,TypeScript会将其推断为any[],这显然不是我们想要的结果。

问题分析

这个问题特别出现在同时满足以下两个条件时:

  1. 使用了泛型参数T
  2. 将泛型参数用于array()方法中

有趣的是,如果单独使用泛型参数而不包裹在array()中,或者使用非泛型的简单类型(如number()),类型推断都能正常工作。

解决方案

根据Yup项目维护者的建议,可以通过显式指定array()方法的类型参数来解决这个问题:

items: array<any, InferType<T>>(entitySchema).required()

这里使用了两个类型参数:

  1. 第一个any参数表示数组的原始类型
  2. 第二个InferType<T>参数表示推断后的类型

深入理解

这种解决方案背后的原理是帮助TypeScript更好地理解类型关系。InferType是Yup提供的一个实用类型,用于从Schema类型推断出最终的TypeScript类型。通过显式指定这些类型参数,我们绕过了TypeScript的类型推断机制在某些复杂泛型情况下的局限性。

最佳实践

对于需要处理分页数据的Yup Schema,推荐以下实现方式:

import { array, number, object, InferType } from 'yup';

const getPaginatedSchema = <T extends AnyObjectSchema>(entitySchema: T) => 
  object({
    count: number().required(),
    items: array<any, InferType<T>>(entitySchema).required(),
    pagination: object({
      skip: number().min(0).integer().required(),
      limit: number().positive().integer().required(),
    }),
  });

type PaginatedSchema<T extends AnyObjectSchema> = InferType<ReturnType<typeof getPaginatedSchema<T>>>;

这种方式不仅解决了类型推断问题,还保持了代码的通用性和类型安全性。

总结

在使用Yup创建复杂的泛型Schema时,可能会遇到类型推断不准确的情况。通过显式指定类型参数,特别是对于array()这样的方法,可以确保类型系统正确理解我们的意图。这虽然增加了一点代码量,但换来了更好的类型安全性和开发体验。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
863
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K