# TS使用

# 简介

TypeScript 是 JavaScript 的超集，通过类型注解提供编译时的静态类型检查。TypeScript简称ts，它的语法包含ES5和ES6语法，但写法更倾向于ES6。

参考链接：

# 安装

ts无法直接使用，需要通过插件typescript编译转成js后再引用才行。

npm install -g typescript

安装好后，新建一个greeter.ts文件，在里面写ts代码，写好后通过tsc命令进行编译，执行tsc greeter.ts命令编译出greeter.js文件后再在greeter.html文件引入 js文件，这样才能正式使用ts。

自动编译

第一种，直接使用命令tsc -w自动监听执行编译。第二种通过vscode。

ts会有一个配置文件tsconfig.json，通过执行命令 tsc --init 创建这个 tsconfig.json 文件。

在tsconfig.json文件中找到 "outDir": "./js"，修改值为 ./js。然后在VScode顶部工具栏打开终端 -> 选择执行任务 -> 选择typescript ->选择监视typescript，然后就会自动创建一个js文件夹。这样每次更改ts文件都会自动编译出js。

# 声明文件

ts的声明文件是以.d.ts为后缀的文件，开发者在声明文件中编写类型声明，ts根据声明文件的内容进行类型检查，然而在有些文件或者第三方库中是没有类型声明的，没有支持ts的写法，在使用变量、调用函数、实例化类的时候ts识别不了这些文件，无法通过类型检查。所以要在声明文件中编写第三方库的类型声明，让ts可以正常地进行类型检查，才能获得对应的代码补全、接口提示等功能。

一般流行的第三方库都支持ts的类型声明，安装时如果默认没有声明文件，可以通过 npm install @types/模块名 -D 去下载其社区为其声明的文件，声明文件的包在@/node_modules/@types里，要是一些比较冷门的库可能没有，我们就要手动为其创建声明文件了。

声明文件写法，通过 declare 关键字声明

declare var // 声明全局变量
declare function // 声明全局方法
declare class // 声明全局类
declare enum // 声明全局枚举类型
declare namespace // 声明（含有子属性的）全局对象
// interface 和 type 声明全局类型
/// <reference /> 三斜线指令

declare var a:number
declare function fn(params:number):void {}
declare class Vue {}
declare enum Color {}

手写案例

比如为express库创建一个声明文件，就直接创建 express.d.ts就行。

// index.ts
import express from 'express'
 
const app = express()
 
const router = express.Router()
 
app.use('/api', router)
 
router.get('/list', (req, res) => {
  res.json({
    code: 200
  })
})
 
app.listen(9001,()=>{
  console.log(9001)
})

声明文件

// express.d.ts
declare module 'express' {
  interface Router {
    get(path: string, cb: (req: any, res: any) => void): void
  }
  interface App {
    use(path: string, router: any): void
    listen(port: number, cb?: () => void): void
  }
  interface Express {
    (): App
    Router(): Router
  }
  const express: Express
  export default express
}

参考链接：

TypeScript声明文件文档 (opens new window)

TypeScript声明文件详解 (opens new window)

小满声明文件d.ts (opens new window)

# 项目配置文件

关于ts的配置文件，可以通过tsc --init命令生成 tsconfig.json 文件。

参考链接：TypeScript项目配置文件 (opens new window)

{
  "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": "./", // 解析非相对模块的基地址，默认是当前目录
    // 路径映射，相对于baseUrl
    "paths": {
      "jquery": ["node_modules/jquery/dist/jquery.min.js"] // 如使用jq时不想使用默认版本，而需要手动指定版本，可进行如下配置
      "@/*": ["./src/*"] // 映射@为src目录
    },
    "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下，用于运行时，即编译后引入文件的位置可能发生变化，这也设置可以虚拟src和out在同一个目录下，不用再去改变路径也不会报错
    "listEmittedFiles": true, // 打印输出文件
    "listFiles": true // 打印编译的文件(包括引用的声明文件)
  }
  
  // 同级其他配置
  "include": [ "src/**/*" ], // 指定一个匹配列表（属于自动指定该路径下的所有ts相关文件）
  "exclude": [ "demo.ts" ], // 指定一个排除列表（include的反向操作）
  "files": [ "demo.ts" ] // 指定哪些文件使用该配置（属于手动一个个指定文件）
}

几个常用的

include 指定编译文件默认是编译当前目录下所有的ts文件
exclude 指定排除的文件
target 指定编译js 的版本例如es5 es6
allowJS 是否允许编译js文件
removeComments 是否在编译过程中删除文件中的注释
rootDir 编译文件的目录
outDir 输出的目录
sourceMap 代码源文件
strict 严格模式
module 默认common.js 可选es6模式 amd umd 等

← 常见代码实现数据类型 →