如何在TypeScript中实现批量转换指定类型属性的utility type
批量替换指定属性类型的工具类型实现
要实现这个需求,核心是利用TypeScript的映射类型遍历原类型的所有属性,对每个属性的类型做条件判断:匹配待替换的旧类型(示例中为Date)就替换为目标新类型(示例中为moment),不匹配就保留原类型。这个过程会自动保留原属性的修饰符,比如readonly只读标记、?可选标记,不会破坏原类型的结构约束。
基础版本工具类型
适合批量替换第一层属性中严格匹配旧类型的简单场景:
type ReplaceType<Source, OldType, NewType> = { [Prop in keyof Source]: Source[Prop] extends OldType ? NewType : Source[Prop] }
使用示例
- 准备原类型定义和
moment类型引用:import moment from 'moment' type EmployeeDTO = { firstName: string lastName: string dateOfBirth: Date } - 调用工具类型完成批量转换:
type TransformedEmployee = ReplaceType<EmployeeDTO, Date, moment.Moment> - 最终得到的
TransformedEmployee结构完全符合预期:{ firstName: string lastName: string dateOfBirth: moment.Moment }
适配联合类型的增强版本
实际开发中经常遇到属性为联合类型的场景,比如dateOfBirth: Date | null,上面的基础版本会直接把整个属性替换为moment.Moment,丢失原本的null类型约束。如果需要只替换联合类型中匹配的子分支,保留其余类型约束,可以使用下面的增强版本:
type ReplaceTypeKeepUnion<Source, OldType, NewType> = { [Prop in keyof Source]: Source[Prop] extends infer PropValue // 对联合类型的每个分支单独做判断 ? PropValue extends OldType ? NewType : PropValue : never }
举个实际使用场景,如果原类型定义为:
type EmployeeDTO = { firstName: string lastName: string dateOfBirth: Date resignDate: Date | null }
用增强版本转换后,resignDate的类型会变为moment.Moment | null,不会丢失原本的空值类型约束。
可选扩展:递归替换嵌套结构
如果原类型的属性是嵌套对象,且嵌套对象内也存在需要替换的Date类型,只需要在上述工具类型中增加递归判断逻辑,遇到非原始类型的对象属性时递归调用转换逻辑即可,就能实现全链路的类型替换。
内容的提问来源于stack exchange,提问作者Loi Nguyen Huynh
相关产品推荐
相关产品推荐

