生成tsconfig.json 文件

这个文件是通过tsc --init命令生成的

配置详解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
"compilerOptions": {
  "incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件，第二次编译会在第一次的基础上进行增量编译，可以提高编译的速度
  "tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置
  "diagnostics": true, // 打印诊断信息 
  "target": "ES5", // 目标语言的版本
  "module": "CommonJS", // 生成代码的模板标准
  "outFile": "./app.js", // 将多个相互依赖的文件生成一个文件，可以用在AMD模块中，即开启时应设置"module": "AMD",
  "lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // TS需要引用的库，即声明文件，es5 默认引用dom、es5、scripthost,如需要使用es的高级版本特性，通常都需要配置，如es8的数组新特性需要引入"ES2019.Array",
  "allowJS": true, // 允许编译器编译JS，JSX文件
  "checkJs": true, // 允许在JS文件中报错，通常与allowJS一起使用
  "outDir": "./dist", // 指定输出目录
  "rootDir": "./", // 指定输出文件目录(用于输出)，用于控制输出目录结构
  "declaration": true, // 生成声明文件，开启后会自动生成声明文件
  "declarationDir": "./file", // 指定生成声明文件存放目录
  "emitDeclarationOnly": true, // 只生成声明文件，而不会生成js文件
  "sourceMap": true, // 生成目标文件的sourceMap文件
  "inlineSourceMap": true, // 生成目标文件的inline SourceMap，inline SourceMap会包含在生成的js文件中
  "declarationMap": true, // 为声明文件生成sourceMap
  "typeRoots": [], // 声明文件目录，默认时node_modules/@types
  "types": [], // 加载的声明文件包
  "removeComments":true, // 删除注释 
  "noEmit": true, // 不输出文件,即编译后不会生成任何js文件
  "noEmitOnError": true, // 发送错误时不输出任何文件
  "noEmitHelpers": true, // 不生成helper函数，减小体积，需要额外安装，常配合importHelpers一起使用
  "importHelpers": true, // 通过tslib引入helper函数，文件必须是模块
  "downlevelIteration": true, // 降级遍历器实现，如果目标源是es3/5，那么遍历器会有降级的实现
  "strict": true, // 开启所有严格的类型检查
  "alwaysStrict": true, // 在代码中注入'use strict'
  "noImplicitAny": true, // 不允许隐式的any类型
  "strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量
  "strictFunctionTypes": true, // 不允许函数参数双向协变
  "strictPropertyInitialization": true, // 类的实例属性必须初始化
  "strictBindCallApply": true, // 严格的bind/call/apply检查
  "noImplicitThis": true, // 不允许this有隐式的any类型
  "noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)
  "noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)
  "noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)
  "noImplicitReturns": true, //每个分支都会有返回值
  "esModuleInterop": true, // 允许export=导出，由import from 导入
  "allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块
  "moduleResolution": "node", // 模块解析策略，ts默认用node的解析策略，即相对的方式导入
  "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
  "paths": { // 路径映射，相对于baseUrl
    // 如使用jq时不想使用默认版本，而需要手动指定版本，可进行如下配置
    "jquery": ["node_modules/jquery/dist/jquery.min.js"]
  },
  "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下，用于运行时，即编译后引入文件的位置可能发生变化，这也设置可以虚拟src和out在同一个目录下，不用再去改变路径也不会报错
  "listEmittedFiles": true, // 打印输出文件
  "listFiles": true// 打印编译的文件(包括引用的声明文件)
}
 
// 指定一个匹配列表（属于自动指定该路径下的所有ts相关文件）
"include": [
   "src/**/*"
],
// 指定一个排除列表（include的反向操作）
 "exclude": [
   "demo.ts"
],
// 指定哪些文件使用该配置（属于手动一个个指定文件）
 "files": [
   "demo.ts"
]

namespace命名空间

我们在工作中无法避免全局变量造成的污染，TypeScript提供了namespace 避免这个问题出现。

  • 内部模块，主要用于组织代码，避免命名冲突。
  • 命名空间内的类默认私有
  • 通过 export 暴露
  • 通过 namespace 关键字定义

TypeScript与ECMAScript 2015一样，任何包含顶级import或者export的文件都被当成一个模块。相反地，如果一个文件不带有顶级的import或者export声明，那么它的内容被视为全局可见的（因此对模块也是可见的）

命名空间（namespace）中通过export将想要暴露的部分导出

如果不用export 导出是无法读取其值的

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
namespace A {
    export const a: number = 1000
    export const fn = <T>(arg: T): T => {
        return arg
    }
    fn(a)
}
 
 
namespace B {
     export const b: number = 1000
     export const fn = <T>(arg: T): T => {
        return arg
    }
    fn(b)
}
 
A.a
B.b

嵌套命名空间

1
2
3
4
5
6
7
8
9
10
11
12
13
14
namespace A {
    export namespace B {
        export class Alive {
            params: string
            constructor(params: string) {
                this.params = params
            }
        }
    }
}
 
let x = A.B.Alive
 
new x('AA')

抽离命名空间

a.ts

1
2
3
export namespace A {
    export const a = 1
}

b.ts

1
2
3
import {A} from '../observer/index'
 
console.log(A);

简化命名空间

1
2
3
4
5
6
7
8
9
namespace A  {
    export namespace B {
        export const C = 1
    }
}
 
import X = A.B.C
 
console.log(X);

合并命名空间

  • 重名的命名空间会合并

三斜线指令

  1. 三斜线指令是包含单个XML标签的单行注释。 注释的内容会做为编译器指令使用。
  2. /// <reference path="..." />指令是三斜线指令中最常见的一种。 它用于声明文件间的 依赖。
  3. 类似import，它可以告诉编译器在编译过程中要引入的额外的文件
  4. 三斜线指令仅可放在包含它的文件的最顶端。 一个三斜线指令的前面只能出现单行或多行注释，这包括其它的三斜线指令

Mixins混入

TypeScript混入 Mixins 其实vue也有mixins这个东西 你可以把他看作为合并。

对象混入

可以使用es6的Object.assign 合并多个对象。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
interface Name {
    name: string
}
interface Age {
    age: number
}
interface Sex {
    sex: number
}
 
let people1: Name = { name: "AliveSeven" }
let people2: Age = { age: 20 }
let people3: Sex = { sex: 1 }
 
const people = Object.assign(people1,people2,people3)

类的混入

首先声明两个mixins类 （严格模式要关闭不然编译不过）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
class A {
    type: boolean = false;
    changeType() {
        this.type = !this.type
    }
}
 
 
class B {
    name: string = '七海';
    getName(): string {
        return this.name;
    }
}

下面创建一个类，结合了这两个mixins

首先应该注意到的是，没使用extends而是使用implements。 把类当成了接口

我们可以这么做来达到目的，为将要mixin进来的属性方法创建出占位属性。 这告诉编译器这些成员在运行时是可用的。 这样就能使用mixin带来的便利，虽说需要提前定义一些占位属性

1
2
3
4
5
6
class C implements A,B{
    type:boolean
    changeType:()=>void;
    name: string;
    getName:()=> string
}

最后，创建这个帮助函数，帮我们做混入操作。 它会遍历mixins上的所有属性，并复制到目标上去，把之前的占位属性替换成真正的实现代码。

Object.getOwnPropertyNames()可以获取对象自身的属性，除去他继承来的属性，对它所有的属性遍历，它是一个数组，遍历一下它所有的属性名

1
2
3
4
5
6
7
8
Mixins(C, [A, B])
function Mixins(curCls: any, itemCls: any[]) {
    itemCls.forEach(item => {
        Object.getOwnPropertyNames(item.prototype).forEach(name => {
            curCls.prototype[name] = item.prototype[name]
        })
    })
}

装饰器Decorator

什么是装饰器

  • 装饰器是一种特殊类型的声明，它能够被附加到类声明，方法， 访问符，属性或参数上。
  • 它类似于Java中的那个注解，它会在运行时被调用，被装饰的声明信息做为参数传入。

使用方式

首先在在 tsconfig.json中开启 experimentalDecorators编译器选项

1
2
3
4
5
6
{
    "compilerOptions": {
        "target": "ES6",
        "experimentalDecorators": true
    }
}

装饰器可以应用在如下几处地方

  1. Class
  2. 函数
  3. 函数参数
  4. 属性
  5. get set 访问器

案例：

1
2
3
4
5
6
7
8
9
10
11
let decorator : ClassDecorator = (target : Function) =>{
    console.log(target)
}


@decorator
class A{

}

// [class A]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
let decorator : ClassDecorator = (target : Function) =>{
    // 在目标函数的原型上面定义一个HelloWorld的函数
    // 函数参数为<T>(str : T):T
    target.prototype.HelloWorld = <T>(str : T):T =>{
        return str
    }
}

@decorator
class A{

}

let a = new A();
console.log((<any>a).HelloWorld('helloworld'));   // helloworld

装饰器高阶使用：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 装饰器传入一个string参数
// 返回一个方法，方法是在类的原型上定义了HelloWorld函数
// HelloWorld返回装饰器传入的参数值
let decorator = (str : string) : ClassDecorator =>{
    return (target : Function) => {
        target.prototype.HelloWorld = () =>{
            return str
        }
    }
}

@decorator('AliveSeven')
class A{

}

let a = new A();
console.log((<any>a).HelloWorld()) // AliveSeven