草庐IT

【TypeScript】TS自定义类型之对象属性必选、对象属性可选

不叫猫先生 2023-04-14 原文

🐱 个人主页:不叫猫先生
🙋‍♂️ 作者简介:2022年度博客之星前端领域TOP 2,前端领域优质作者、阿里云专家博主,专注于前端各领域技术,共同学习共同进步,一起加油呀!
💫优质专栏:vue3从入门到精通TypeScript从入门到实践
📢 资料领取:前端进阶资料以及文中源码可以找我免费领取
🔥 前端学习交流:博主建立了一个前端交流群,汇集了各路大神,一起交流学习,期待你的加入!(文末有我wx或者私信)。

目录

专栏介绍

TypeScript从入门到实践专栏是博主在学习和工作过程中的总结,内容会不断进行精进,欢迎订阅哦,学会TS不迷路。

TS系列标题
基础篇TS入门(一)
基础篇TS类型声明(二)
基础篇TS接口类型(三)
基础篇TS交叉类型&联合类型(四)
基础篇TS类型断言(五)
基础篇TS类型守卫(六)
进阶篇TS函数重载(七)
进阶篇TS泛型(八)
进阶篇TS装饰器(九)
进阶篇TS自定义类型之对象属性必选、对象属性可选

前沿

TS中实现对象属性必选、对象属性在开发过程中十分常见,前端在传参数时,有些参数比必传,有些是选传,我们可以定一个多个对象来实现传参,但是这让代码变得冗余。我们可以通过TS定义数据类型来实现。

一、把对象类型的指定key变成可选

1.实现用到的ts基础

  • keyof T
    生成新的类型,也就是联合字面量类型,组成的字面量类型是T的属性名称所组成的。

  • Pick
    从定义的类型中指定一组属性生成新的类型

  • in
    遍历枚举类型,可跟keyof一起使用做类型转换

 type A = {
	name:string,
	age:number
 }
 type changeA<T> = {
	 [K in keyof T]:string
 }
 let resultType:changeA<A> = {
	name:'zhangsan',
	age:'11'
 }
  • Exclude
    从联合类型UnionType中排除一个类型ExcludedMembers

2.代码实现

type PartialByKeys<T, K extends keyof T> = {
	[P in K]?: T[P];
} & Pick<T, Exclude<keyof T, K>>;

type Simplity<T> = { [P in keyof T]: T[P] }

type Info = {
	name: string,
	id: number,
	age: number
	class: string
}

type resultType = Simplity<PartialByKeys<Info, 'id'|'name'>>

resultType数据类型如下:

2.1 PartialByKeys

首先看PartialByKeys,实现了可选属性,可选属性实现使用了?,主要通过[P in K]?: T[P]语句实现。

PartialByKeys<T, K extends keyof T> = {
	[P in K]?: T[P];
}
  • T 是 Info
  • K是'id'|'name'
  • keyof T是'name'| 'id'| 'age'| 'class'
  • P in K 中 P 是 K 的每一项,即id,name
  • T[P]也就是取属性名idname属性值,即numberstring

所以PartialByKeys的目的是将对象类型指定的key抽取出来最为可选,生成一个新的对象,最后得到的结果如下:

{ 
   id? : number | undefined ,
   name? : string | undefined
}

2.2 Pick<T, Exclude<keyof T, K>>

上面得到了可选属性的对象类型,怎么把除了可选属性的其他属性对象类型与可选属性对象类型合并呢,我们最终结果是要一个包括info对象中所有属性的对象类型。思路如下:

  • 首先需要把可选属性去除,得到一个不包括可选属性的对象类型
  • 将剩余属性组成的对象类型与可选属性组成的对象类型交叉,得到最终结果

使用TS中的Exclude工具类型,从联合类型中去除指定属性,最终得到联合类型。

Exclude<keyof T, K>
  • K为'id' | 'name'
  • keyof T为'name'| 'id'| 'age'| 'class'

接着使用Pick工具类型,从对象的类型(info)中抽取出指定类型的键值,生成一个新的对象类型。

Pick<T, Exclude<keyof T, K>>

后半部分的目的主要是抽取出来必填属性组成一个新的对象,得到结果:'age' | 'class',然后通过Pick生成新对象得到如下对象类型:

{
   age:number,
   class:string
}

最后将两个对象类型交叉就得到了最终结果。

二、实现属性必填

实现属性必填与属性选填的逻辑基本差不多,主要是在抽取指定属性的生成新的对象时有一些区别。

1.代码实现

type RequiredByKeys<T, K extends keyof T> = {
	[P in K]-?: T[P];
} & Pick<T, Exclude<keyof T, K>>;

type Simplity<T> = { [P in keyof T]: T[P] }

type Info = {
	name: string,
	id: number,
	age?: number
	class: string
}

type resultType = RequiredByKeys<PartialByKeys<Info, 'age'|'class'>>

得到结果如下:

用问号设置可选只读,-号可以移除可选和只读readonly,所以将可选的属性进行传参。
实现思路具体如下:

  • 去除可选属性得到新的对象类型(必填属性对象)
  • 抽取出除去必填的属性生成新的代谢(可选属性对象)
  • 交叉合并
RequiredByKeys<T, K extends keyof T> = {
	[P in K]-?: T[P];

上面代码得到结果是:

{
   name:string,
   id:number
}

接下来看这个:

Pick<T, Exclude<keyof T, K>>;

得到结果如下:

{
   age:number,
   class:string
}

最后合并得到最终结果

有关【TypeScript】TS自定义类型之对象属性必选、对象属性可选的更多相关文章

  1. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  2. ruby - Facter::Util::Uptime:Module 的未定义方法 get_uptime (NoMethodError) - 2

    我正在尝试设置一个puppet节点,但ruby​​gems似乎不正常。如果我通过它自己的二进制文件(/usr/lib/ruby/gems/1.8/gems/facter-1.5.8/bin/facter)在cli上运行facter,它工作正常,但如果我通过由ruby​​gems(/usr/bin/facter)安装的二进制文件,它抛出:/usr/lib/ruby/1.8/facter/uptime.rb:11:undefinedmethod`get_uptime'forFacter::Util::Uptime:Module(NoMethodError)from/usr/lib/ruby

  3. ruby-on-rails - 按天对 Mongoid 对象进行分组 - 2

    在控制台中反复尝试之后,我想到了这种方法,可以按发生日期对类似activerecord的(Mongoid)对象进行分组。我不确定这是完成此任务的最佳方法,但它确实有效。有没有人有更好的建议,或者这是一个很好的方法?#eventsisanarrayofactiverecord-likeobjectsthatincludeatimeattributeevents.map{|event|#converteventsarrayintoanarrayofhasheswiththedayofthemonthandtheevent{:number=>event.time.day,:event=>ev

  4. ruby-on-rails - 如果为空或不验证数值,则使属性默认为 0 - 2

    我希望我的UserPrice模型的属性在它们为空或不验证数值时默认为0。这些属性是tax_rate、shipping_cost和price。classCreateUserPrices8,:scale=>2t.decimal:tax_rate,:precision=>8,:scale=>2t.decimal:shipping_cost,:precision=>8,:scale=>2endendend起初,我将所有3列的:default=>0放在表格中,但我不想要这样,因为它已经填充了字段,我想使用占位符。这是我的UserPrice模型:classUserPrice回答before_val

  5. ruby-on-rails - Rails 3.2.1 中 ActionMailer 中的未定义方法 'default_content_type=' - 2

    我在我的项目中添加了一个系统来重置用户密码并通过电子邮件将密码发送给他,以防他忘记密码。昨天它运行良好(当我实现它时)。当我今天尝试启动服务器时,出现以下错误。=>BootingWEBrick=>Rails3.2.1applicationstartingindevelopmentonhttp://0.0.0.0:3000=>Callwith-dtodetach=>Ctrl-CtoshutdownserverExiting/Users/vinayshenoy/.rvm/gems/ruby-1.9.3-p0/gems/actionmailer-3.2.1/lib/action_mailer

  6. ruby-on-rails - 在混合/模块中覆盖模型的属性访问器 - 2

    我有一个包含模块的模型。我想在模块中覆盖模型的访问器方法。例如:classBlah这显然行不通。有什么想法可以实现吗? 最佳答案 您的代码看起来是正确的。我们正在毫无困难地使用这个确切的模式。如果我没记错的话,Rails使用#method_missing作为属性setter,因此您的模块将优先,阻止ActiveRecord的setter。如果您正在使用ActiveSupport::Concern(参见thisblogpost),那么您的实例方法需要进入一个特殊的模块:classBlah

  7. ruby-on-rails - 如何验证非模型(甚至非对象)字段 - 2

    我有一个表单,其中有很多字段取自数组(而不是模型或对象)。我如何验证这些字段的存在?solve_problem_pathdo|f|%>... 最佳答案 创建一个简单的类来包装请求参数并使用ActiveModel::Validations。#definedsomewhere,atthesimplest:require'ostruct'classSolvetrue#youcouldevencheckthesolutionwithavalidatorvalidatedoerrors.add(:base,"WRONG!!!")unlesss

  8. ruby-on-rails - form_for 中不在模型中的自定义字段 - 2

    我想向我的Controller传递一个参数,它是一个简单的复选框,但我不知道如何在模型的form_for中引入它,这是我的观点:{:id=>'go_finance'}do|f|%>Transferirde:para:Entrada:"input",:placeholder=>"Quantofoiganho?"%>Saída:"output",:placeholder=>"Quantofoigasto?"%>Nota:我想做一个额外的复选框,但我该怎么做,模型中没有一个对象,而是一个要检查的对象,以便在Controller中创建一个ifelse,如果没有检查,请帮助我,非常感谢,谢谢

  9. ruby - 主要 :Object when running build from sublime 的未定义方法 `require_relative' - 2

    我已经从我的命令行中获得了一切,所以我可以运行rubymyfile并且它可以正常工作。但是当我尝试从sublime中运行它时,我得到了undefinedmethod`require_relative'formain:Object有人知道我的sublime设置中缺少什么吗?我正在使用OSX并安装了rvm。 最佳答案 或者,您可以只使用“require”,它应该可以正常工作。我认为“require_relative”仅适用于ruby​​1.9+ 关于ruby-主要:Objectwhenrun

  10. Ruby 写入和读取对象到文件 - 2

    好的,所以我的目标是轻松地将一些数据保存到磁盘以备后用。您如何简单地写入然后读取一个对象?所以如果我有一个简单的类classCattr_accessor:a,:bdefinitialize(a,b)@a,@b=a,bendend所以如果我从中非常快地制作一个objobj=C.new("foo","bar")#justgaveitsomerandomvalues然后我可以把它变成一个kindaidstring=obj.to_s#whichreturns""我终于可以将此字符串打印到文件或其他内容中。我的问题是,我该如何再次将这个id变回一个对象?我知道我可以自己挑选信息并制作一个接受该信

随机推荐