TypeScript 内置工具详谈
点击上方 程序员成长指北,关注公众号
回复1,加入高级Node交流群
前言
TypeScript 提供了几种实用程序类型来助力常见的类型转换。这些实用程序是全局可用的。
也就是说全局声明了一些Type
, 调用Type
就可以方便地进行一些类型转换或者创建新的类型。
不会这些函数一样能写TypeScript
你不会真的就不看下文了吧🤣?, 但是掌握后能让你写TypeScript
事半功倍。且掌握这些内置Type
是十分必要的。
本文章主要对一些比较少用或者难理解的类型做了比较详细的说明。比如 ThisType<T>
等
1、Partial 将一个类型的属性全部变为可选
定义
type Partial<T> = {
[P in keyof T]?: T[P];
};
复制代码
从上面的代码中可以看出来该Type
使用时需要传入一个泛型T
。内部遍历T
的所有属性然后创建一个新的 Type
,新的Type
的所有属性使用 ?
标识,使之为可选。
keyof
会遍历一个Interface
的所有属性名称(key), 生成一个联合类型 "name" | "age" ...
,然后可以得到下面代码
P in "name" | "age"
这就很明白能看出来了,表明了P
为右侧类型
使用案例
interface UserInfo {
name:string;
age:number;
}
// 这里会将 UserInfo 所有的属性变为可选
const foo:Partial<UserInfo> = {
name:"张三"
}
复制代码
2、Required 将一个类型的属性全部变为必选
定义
type Required<T> = {
[P in keyof T]-?: T[P];
};
复制代码
该Type
和Partial
刚好是相反的。从上面的代码中可以看出来该Type
实用时需要传入一个泛型T
。内部使用-?
将T
的每个属性去除可选标识使之变成为必填。
使用案例
interface UserInfo {
name?:string;
age?:number;
}
// 这里会将 UserInfo 所有可选的属性变为必选
const foo:Required<UserInfo> = {
name:"张三",
age:18
}
复制代码
3、Readonly 将一个类型的属性全部变为只读状态
定义
type Readonly<T> = {
readonly [P in keyof T]: T[P];
};
复制代码
从上面的代码中可以看出来该Type
实用时需要传入一个泛型T
。内部使用readonly
将T
的每个属性去除可选标识使之变成为只读。
使用案例
interface UserInfo {
name?:string;
age?:number;
}
const foo:Readonly<UserInfo> = {
name:"张三",
age:18
}
foo.name = '李四';// error: 无法分配到 "name" ,因为它是只读属性
复制代码
4、Record 构造一个字面量对象 Type
定义
type Record<K extends keyof any, T> = {
[P in K]: T;
};
复制代码
Record
用于方便地构造一个字面量对象。其作用和 { [propName:string]:any }
有些许类似。
Record
只需要传入两个 Type
即可创建一个新的 Type
,相比于 { [propName:string]:any }
能方便一些。当然除了方便外功能也比它强大,因为Record
第一个参数可接收一组key
,这样就可以做到定义出一个完整的 Type
了。
使用案例
// 这是通过 interface 定义出来的。
interface UserInfo {
name:string;
age:number;
}
// 我们用 Record 来实现一遍 UserInfo 。
// 注意:后面一个形参和 UserInfo 的是不一样的,因为 Record 第二个参数只能接受一个类型。所以这里要么用 any,要么用这种联合类型。
type UserInfoT = Record<"name" | "age", string | number>
// 结果
// type UserInfoT = {
// name:string | number;
// age:string | number;
// }
复制代码
5、Pick 从一个 Type 中选取一些属性来构造一个新的对象 Type
定义
type Pick<T, K extends keyof T> = {
[P in K]: T[P];
};
复制代码
Pick
也用于方便地构造一个字面量对象。其作用和 Record
有些许类似。
使用案例
interface UserInfo {
name:string;
age:number;
}
// 这时候我们只需要 UserInfo 的 name 属性。
type UserInfoT = Pick<UserInfo, "name">
复制代码
6、Omit 从一个对象类型中删除一些属性来构造一个新的对象 Type
定义
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
复制代码
日常使用中Omit
是一个使用频率可能比较高的。和 Pick
刚刚相反,用于排除不需要的属性。
使用案例
interface UserInfo {
name:string;
age:number;
}
// 这时候我们不需要 UserInfo 的 name 属性。
type UserInfoT = Omit<UserInfo, "name">
复制代码
7、Exclude 排除一个联合类型中的某一些类型来构造一个新 Type
定义
type Exclude<T, U> = T extends U ? never : T;
复制代码
上面说的 Omit
和 Pick
都是对一个字面量对象 Type
的操作。如果要对一个联合类型操作的话需要用到 Exclude
和 Extract
使用案例
// 排除掉 "name"
type UserInfoT = Exclude<"name" | "age", "name">;
// 等价于
type UserInfoA = "age";
复制代码
8、Extract 提取出一个联合类型中的某一些类型来构造一个新 Type
定义
type Extract<T, U> = T extends U ? T : never;
复制代码
和 Exclude
恰好相反。
使用案例
// 从 T1 中 提取出 T2
type T1 = "name" | "age" | "hob";
type T2 = "name" | "age";
type UserInfoT = Extract<T1, T2>;
// 等价于
type UserInfoA = "name" | "age";
复制代码
既然是提出哪为啥不直接用定义好的 T2?
因为这样可以保证 UserInfoT
的类型一定是在 T1
中存在的;
9、NonNullable 从类型中排除 null 和 undefined 来构造一个新的 Type
定义
type NonNullable<T> = T extends null | undefined ? never : T;
复制代码
使用案例
// 从 UserInfoK 中 排除掉 null | undefined
type UserInfoK = NonNullable<"name" | "hob" | undefined>;
// 等价于
type UserInfoKA = "name" | "hob";
复制代码
10、Parameters 从 [函数 Type] 的形参构造一个数组 Type
定义
type Parameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? P : never;
复制代码
infer
标识一个待推导类型,上面定义的意思是:如果 T 为函数类型,那就返回函数的形参。
ps: infer
和变量似的,先定义一个 infer P
然后 Ts 就会自动推导函数的形参或者返回值、或者数组元素等,然后开发者在合适的位置使用定义好的infer P
即可。
一个简单的infer
案例。
加入有这样一个需求:需要将数组类型的 Type
变为联合类型。其他类型的则不变。这样我们就可以写一个这样的 Type
type ArrayToUnion<T> = T extends Array<infer Item> ? Item : T;
const a:ArrayToUnion<[string, number]> = "111"; // a: string | number
const b:ArrayToUnion<string | number> = "111"; // a: string | number
复制代码
从这个案列的a
变量可以看出作用,a
变量的类型定义为ArrayToUnion<[string, number]>
,这里传入的是个数组[string, number]
被ArrayToUnion
处理为了string | number
。
使用案例
// 定义一个函数
function getUserInfo(id:string, group:string){}
// 获取到函数需要的形参 Type[]
type GetUserInfoArg = Parameters<typeof getUserInfo>;
const arg:GetUserInfoArg = [ "001", "002" ];
getUserInfo(...arg);
复制代码
ps: 上面代码中的typeof
是 ts 提供的操作符不是 js 中的那个typeof
,只能用到 ts 的类型定义中, 所以使用typeof getUserInfo
才能指向函数Type
11、ConstructorParameters 从定义的[构造函数]的形参构造数组 Type
定义
type ConstructorParameters<T extends abstract new (...args: any) => any> = T extends abstract new (...args: infer P) => any ? P : never;
复制代码
实现原理完全和 Parameters
一样,只不过这个方法接受的事一个类。
使用案例
class User{
constructor(id:string, group:string){}
}
type NewUserArg = ConstructorParameters<typeof User>;
const arg:NewUserArg = [ "001", "002"];
new User(...arg);
复制代码
12、ReturnType 用函数 Type 的返回值定义一个新的 Type
定义
type ReturnType<T extends (...args: any) => any> = T extends (...args: any) => infer R ? R : any;
复制代码
使用 infer
实现。比 Parameters
更简单,可以去看上面的 Parameters
就能明白这段代码意思。
使用案例
// 定义一个函数 Type
type GetUserInfo = ()=>string;
const rt:ReturnType<GetUserInfo> = 'xxx';
复制代码
13、InstanceType 从一个构造函数的实例定义一个新的 Type
定义
type InstanceType<T extends abstract new (...args: any) => any> = T extends abstract new (...args: any) => infer R ? R : any;
复制代码
使用 infer
实现。和ReturnType
实现原理完全一样。
使用案例
// 定义一个函数 Type
type GetUserInfo = ()=>string;
const rt:ReturnType<GetUserInfo> = 'xxx';
复制代码
14、ThisParameterType 提取函数 Type 的 this 参数生成一个新的 Type
定义
type ThisParameterType<T> = T extends (this: infer U, ...args: any[]) => any ? U : unknown;
复制代码
从上面定义看出该 Type
对函数的第一个形参 this
做了infer
推导。然后返回了推导出来的this
。不清楚infer
的话,往上翻,去仔细看看Parameters
一节的说明。
使用案例
// 定义一个函数,并且定义函数 this 类型。
function getUserInfo(this:{ name:string }){}
const getUserInfoArgThis: ThisParameterType<typeof getUserInfo> = {
name:"王"
};
复制代码
15、OmitThisParameter 忽略函数 Type 的 this 参数,生成一个新的函数 Type
定义
type OmitThisParameter<T> = unknown extends ThisParameterType<T> ? T : T extends (...args: infer A) => infer R ? (...args: A) => R : T;
复制代码
这个Type
看着略微复杂。咋们拆一下看就会简单很多。
首先说明一下这个Type
的这些判断都是干嘛的。
上面定义意思是:如果传入的T
没有this
参数就直接返回T
,如果有this
参数就继续进行判断,
第二层判断为:如果T不是函数那也会直接返回T
,最后是重新定义了一个函数然后返回。其中使用infer
定义了我们所需要的形参和返回值。
这里在座的各位可能会在(...args: infer A) => infer R ? (...args: A) => R : T
这里产生疑惑。
上面的写法会直接把this
参数过滤掉,为了证实这点,我们可以实现一下:
type NoThis<T> = T extends (...args: infer A) => infer R ? A : T
const a:NoThis<typeof getUserInfo>; // a: [id: string]
复制代码
上面代码中我们直接返回了推导的A
,得到了形参A
的类型。这里面是不会包含this
的。
使用案例
// 定义一个函数
function getUserInfo(this:{ name:string }, id:string){}
// 去除 getUserInfo 函数 this 参,然后创建出来了一个新类型
const aaa: OmitThisParameter<typeof getUserInfo> = (id:string)=>{}
复制代码
16、ThisType 给对象标记 this 接口
这个类型在 lib.d.ts 中定义的就是一个{}
空标签,所以用的时候往往比较困惑。特别是没注意看到官网上写的必须开启--noImplicitThis
时才可以用的时候。就算你看到了,但是你在他们案例中如果不注意的话还是搞不懂,因为官方案例中设置了这个编译规则 // @noImplicitThis: false
。
noImplicitThis
规则开启后在函数中的this
在不定义的情况下不能使用,相当于严格模式,默认情况下noImplicitThis
的值为false
,除非手动开启,否则ThisType
毫无作用。
使用案例
// 定义一个函数
function getUserInfo(this:{ name:string }, id:string){}
// 去除 getUserInfo 函数 this 参,然后创建出来了一个新函数类型
const aaa: OmitThisParameter<typeof getUserInfo> = (id:string)=>{}
复制代码
17、Uppercase 将字符串中的每个字符转换为大写
这是对字符串的操作,所有对字符串的操作在 lib.d.ts 中都找不到具体的定义,文档上说是为了提升性能。
type MyText = "Hello, world"
type A = Uppercase<MyText>; // type A = "HELLO, WORLD"
复制代码
18、Lowercase 将字符串中的每个字符转换为小写
type MyText = "Hello, world"
type A = Lowercase<MyText>; // type A = "hello, world"
复制代码
19、Capitalize 将字符串中的第一个字符转换为大写
type MyText = "hello, world"
type A = Capitalize<MyText>; // type A = "Hello, world"
复制代码
20、Uncapitalize 将字符串中的第一个字符转换为小写
type MyText = "Hello, world"
type A = Uncapitalize<MyText>; // type A = "hello, world"
复制代码
以上就是全部的内容啦~
一款 javascript AST 节点操作插件推荐:
qnn-object-ast-handle[1] -使用操作 js 字面量对象的方式来操作代码文件。使 AST 节点操作变得毫不费力。
关于本文
来源:爱玫瑰的小王子
https://juejin.cn/post/6988364988427534349
我组建了一个氛围特别好的 Node.js 社群,里面有很多 Node.js小伙伴,如果你对Node.js学习感兴趣的话(后续有计划也可以),我们可以一起进行Node.js相关的交流、学习、共建。下方加 考拉 好友回复「Node」即可。
“分享、点赞、在看” 支持一波