# typescript
TypeScript 是一种由微软开发的开源的编程语言,它是 JavaScript 的一个超集,扩展了 JavaScript 的语法
安装:
npm install -g typescript
使用:
tsc greeter.ts
# ts 数据类型
# 布尔值, 字符串,数字
// 布尔值
let isDone: boolean = false;
// 字符串
let name: string = "bob";
// 数字
let decLiteral: number = 6;
let octalLiteral: number = 0o744;
# 数组,元组 Tuple
# 枚举
// 默认情况下,从0开始为元素编号
enum Color {Red, Green, Blue}
let c: Color = Color.Green;
// 全部手动赋值
enum Color {Red = 1, Green = 2, Blue = 4}
let c: Color = Color.Green;
// 枚举类型提供的一个便利是你可以由枚举的值得到它的名字。
enum Color {Red = 1, Green, Blue}
let colorName: string = Color[2]; // 'Green'
# void 和 any
// any : 不希望类型检查器对这些值进行检查而是直接让它们通过编译阶段的检查
let notSure: any = 4;
notSure = "maybe a string instead";
notSure = false;
// void类型像是与any类型相反,它表示没有任何类型。 当一个函数没有返回值时,返回void:
function warnUser(): void {
console.log("This is my warning message");
}
// void 只能为它赋予undefined和null
let unusable: void = undefined;
# undefined 和 null
let u: undefined = undefined;
let n: null = null;
默认情况下 null 和 undefined 是所有类型的子类型。 就是说你可以把 null 和 undefined 赋值给 number 类型的变量。
# Object
表示非原始类型,也就是除 number,string,boolean,symbol,null 或 undefined 之外的类型
# 类型断言
- <尖括号>
let someValue: any = "this is a string";
let strLength: number = (<string>someValue).length;
- as(JSX 只支持 as)
let someValue: any = "this is a string";
let strLength: number = (someValue as string).length;
# tsconfig.json 配置
如果一个目录下存在一个 tsconfig.json 文件,那么它意味着这个目录是 TypeScript 项目的根目录。 tsconfig.json 文件中指定了用来编译这个项目的根文件和编译选项
示例
{
"compilerOptions": {
"module": "system",
"noImplicitAny": true,
"removeComments": true,
"preserveConstEnums": true,
"outFile": "../../built/local/tsc.js",
"sourceMap": true
},
"extends": "./tsconfig1.ts",
"files": ["core.ts"],
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
# files, include, exclude
{
"files": ["core.ts"],
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
- files: 指定一个包含相对或绝对文件路径的列表。优先级比 exclude 高
- include: 从那个文件夹开始编译
- exclude: 编译时忽略哪些文件,默认情况下会排除
node_modules,bower_components,jspm_packages, <outFile>
目录
支持的匹配模式
- 匹配 0 或多个字符(不包括目录分隔符)
- ? 匹配一个任意字符(不包括目录分隔符)
- **/ 递归匹配任意子目录
# extends
{
"extends": "./configs/base",
}
tsconfig.json 文件可以利用 extends 属性从另一个配置文件里继承配置
继承配置文件的 files,include 和 exclude 覆盖源配置文件的属性
配置文件里的相对路径在解析时相对于它所在的文件
# compilerOptions
参考文档:https://www.tslang.cn/docs/handbook/compiler-options.html
compilerOptionsp 是编译配置,包含很多选项
# paths
模块名到基于 baseUrl 的路径映射的列表(别名配置)
# jsx
"jsx": "react-jsx",
在 .tsx 文件里支持 JSX
# 实用技巧
# infer
infer 可以在 extends 的条件语句中推断待推断的类型, 例如在文档的示例中,使用 infer 来推断函数的返回值类型
type ReturnType<T> = T extends (...args: any[]) => infer R ? R : any;
理解为:
- 如果 T 继承了 (...args: any[]) => any 类型,则返回类型 R,否则返回 any。
- R 被定义在 extends (...args: any[]) => infer R 中,即 R 是从传入参数类型中推导出来的。
// 如果泛型 T 是 ()=> infer R 的子集,则返回 infer R 获取到的类型,否则返回 boolean
type Func<T> = T extends () => infer R ? R : boolean;
// 没命中 `T extends () => infer R`, 所以类型是 boolean
let func1: Func<"xxxx">; // boolean
let func2: Func<(p: any) => string>; // boolean
/*
1. 命中 `T extends () => infer R`;
2. func3 类型是 R;
3. R 其实就是 `() => string` 类型的返回值;
*/
let func3: Func<() => string>;
/* 其它例子 */
type Obj<T> = T extends { a: infer VT; b: infer VT } ? VT : number;
let obj1: Obj<string>; // number;
let obj2: Obj<true>; // number;
let obj3: Obj<{ a: string; b: string }>; // string
let obj4: Obj<{ a: number; b: string }>; // a、b 为不同类型时,返回联合类型: string | number
例子: 获取第一个元素 First<T>
type First<T> = T extends [infer P, ...infer Rest] ? P : never;
type FirstType = First<["1", "2"]>; //type FirstType = "1"
# Required
- Required<T> 将某个类型里的属性全部变为必选项
# Readonly
- Readonly<T> 将某个类型所有属性变为只读属性
# Record
Record<K extends keyof any, T>
将对象 K 中的所有属性,都转换为类型 T
type Record<K extends keyof any, T> = {
[P in K]: T;
};
type Info = { title: string };
type Page = "home" | "about";
const v: Record<Page, Info> = {
home: { title: "v1" },
about: { title: "v2" },
};
# Partial
将某个类型的属性,全部变为可选
type Partial<T> = {
[K in keyof T]?: T[K];
};
# Omit
将一个类型的某些子类型,进行过滤,组成新类型(和 Pick 相反)
interface Todo = {
title: sting;
name: string;
completed: boolean;
}
type PickTest = Omit<Todo, 'completed'>;
// 等同于
type PickTest = {
title: sting;
name: string;
}
# Pick
将某个类型的子类型挑选出来,组成一个新的类型(和 Omit 相反)
interface Todo = {
title: sting;
name: string;
completed: boolean;
}
type PickTest = Pick<Todo, 'name' | 'completed'>;
// 等同于
type PickTest = {
name: string;
completed: boolean;
}
# in
in 可以遍历多个字符类型
type Keys = "a" | "b";
type Obj = {
[k in Keys]: number;
};
// 等同于
type Obj = {
a: number;
b: number;
};
# typeof
typeof 可以获取一个变量的声明类型
interface Person {
name: string;
age: number;
}
const sem: Person = {
name: "lcr",
age: 18,
};
type Sem = typeof sem; // Person
# keyof
keyof 返回一个对象所有的 key 组成的类型
interface Penson = {
name: string;
age: number;
}
type K1 = keyof Penson; // 'name' | 'age'
type K2 = keyof Person[]; // 'length' | 'pop' | 'toString' ...
type K3 = keyof { [s: string]: string; } // string | number
# Exclude
将 T 中某些属于 U 的类型移除掉
type Exclude<T, U> = T extends U ? never : T;
type A = number | boolean | string;
type B = number | boolean;
type Foo = Exclude<A, B>; // 相当于 type Foo = string;
# Extract
从 T 中提取 U, 和 Exclude 相反
type Extract<T, U> = T extends U ? T : never;
type A = number | boolean | string;
type B = number | boolean;
type Foo = Extract<A, B>; // 相当于 type Foo = number | boolean;
# ReturnType
获取函数的返回值
type ReturnType<T extends (...args: any) => any> = T extends (
...args: any
) => infer R
? R
: any;
type t = ReturnType<(name: string) => string | number>; // type t = string | number
# NonNullable
从泛型 T 中排除 undefined 和 null
type NonNullable<T> = T extends null | undefined ? never : T;
type t = NonNullable<"name" | undefined | null>; // type t = 'name'
# Parameters
以元组的方式获得函数的入参类型
type Parameters<T extends (...args: any) => any> = T extends (
...args: infer P
) => any
? P
: never;
// type t = [string]
type t = Parameters<(name: string) => any>;
// type t2 = [string] | [number]
type t2 = Parameters<((name: string) => any) | ((age: number) => any)>;
# declare
declare 是用来定义全局变量、全局函数、全局命名空间、js modules、class 等
- declare global 为全局对象 window 增加的新属性
declare global {
interface Window {
csrf: string;
}
}
# typings.d.ts
某个文件夹添加 typings.d.ts 文件,那么该文件夹下所有*.ts 和*.txs 文件,都可以使用 typings.d.ts 定义的类型,无需引入
下面为例子,src 下面所有的.tsx 和.ts 文件可以这样使用 Global.T1 类型
declare namespace Global {
type T1 = {
name: string;
};
type T2 = {
title: string;
};
}
# 三斜线指令
三斜线是引入文件的类型,它用于声明文件间的依赖, 三斜线指令仅可放在包含它的文件的最顶端
注意:
只可使用在 d.ts 文件中
# ///<reference path="..."/>
用路径声明依赖
/// <reference path="..." />
# ///<reference types="..."/>
声明对某个包的依赖
/// <reference types="node" />
上面例子表明这个文件使用了 @types/node/index.d.ts 里面声明的名字; 并且这个包需要在编译阶段与声明文件一起被包含进来
# /// <reference no-default-lib="true"/>
这个指令把一个文件标记成默认库。 这个指令告诉编译器在编译过程中不要包含这个默认库(比如,lib.d.ts)。 这与在命令行上使用 --noLib 相似
一些例子:
文件: Validation.ts:
namespace Validation {
export interface StringValidator {}
}
文件: LettersOnlyValidator.ts:
/// <reference path="Validation.ts" />
namespace Validation {
export class LettersOnlyValidator implements StringValidator {}
}
文件 ZipCodeValidator.ts:
/// <reference path="Validation.ts" />
namespace Validation {
export class ZipCodeValidator implements StringValidator {}
}
文件 Test.ts:
/// <reference path="Validation.ts" />
/// <reference path="LettersOnlyValidator.ts" />
/// <reference path="ZipCodeValidator.ts" />
let validators: { [s: string]: Validation.StringValidator } = {};
validators["ZIP code"] = new Validation.ZipCodeValidator();
validators["Letters only"] = new Validation.LettersOnlyValidator();
# T[number]
type T = ["a", "b", "c"];
type BB = T[number]; // type BB = "a" | "b" | "c"
# . . . 语法
type First<T> = T extends [infer P, ...infer Rest] ? P : never;