likes
comments
collection
share

TS 完全指南之知识扩展（六）

作者站长头像
站长
· 阅读数 37

TS 模块化和 .d.ts

  • TS 支持两种方式来控制我们的作用域
  • 模块化：每个文件可以是一个独立的模块，支持 ESModule，也支持 CommonJS

如果文件内没有任何 export 或 import ，而你又希望将它作为模块使用，即使它没有导出任何内容，添加下面这行代码

TS 完全指南之知识扩展（六）
  • 内置类型导入（Inline type imports），使用 type 前缀 ，下面两种方式都表示导入一个类型
TS 完全指南之知识扩展（六） TS 完全指南之知识扩展（六）
  • 命名空间：通过 namespace 来声明一个命名空间，主要是在早期将模块内部，再进行作用域的划分，防止命名冲突
TS 完全指南之知识扩展（六）

类型声明和查找

  • 之前我们写的 const imageEl = document.getElementById ("image") as HTMLImageElement，这个 HTMLImageElement 类型来自于哪里呢？
  • 这就涉及到对类型的管理和查找规则了，除了我们写的 .ts 的代码文件，其实还有个 .d.ts 文件，它是用来做类型声明（declare） 或者 类型定义（Type Definition） 文件
  • 当我们写一个类型时候，会在内置类型声明、外部定义类型声明、自己定义类型声明里查找

内置类型声明

  • TS 帮我们内置了一些运行时标准化 API 的声明文件
  • 比如 Function、String、Math、Date、RegExp、Error 等内置类型
  • 也包含运行环境中的 DOM 、BOM API，比如 Window、Document、HTMLElement、Event、NodeList等
  • 很多常用方法其实 TS 已经帮你声明好了，具体地址：github.com/Microsoft/T…
TS 完全指南之知识扩展（六）

内置声明的环境

  • 我们可以通过 target 和 lib 决定哪些内置类型声明可以使用
  • 例如，startsWith 字符串方法 ECMAScript 6 版本才开始使用，我们就可以修改选项以获取新 API 的类型
  • www.typescriptlang.org/tsconfig#li…

外部定义类型声明（第三方库）

  • 第三方库使用的时候也需要类型声明
  • 方式一：库自带 d.ts 的类型声明文件，比如 axios
  • 方式二：通过社区公有库 DefinitelyTyped 存放类型声明文件，比如我们安装 react 类型声明 npm i @types/react --save-dev

外部定义类型声明（自定义声明）

  • 情况一：纯 JS 第三方库，比如 lodash，如果也没有类型声明库安装，我们就需要手动为其添加类型声明
  • 情况二：自己项目声明一些公共的类型，方便复用

声明文件 d.ts

  • .d.ts 文件是声明文件（Declaration File），用于描述 JavaScript 模块、类、函数、变量等的类型信息
  • 如果需要为第三方库或者自己库编写全局通用的声明，就可以创建 .d.ts
declare var 声明全局变量
declare const 声明全局常量
declare function 声明全局方法
declare class 声明全局类
declare enum 声明全局枚举类型
declare namespace 声明（含有子属性的）全局对象
interface 和 type 声明全局类型

xxx.d.ts

TS 完全指南之知识扩展（六）

使用的地方就可以放心使用，因为 .d.ts 结尾的文件声明都是全局

TS 完全指南之知识扩展（六）

.d.ts 和 JS 文件配合使用

TS 完全指南之知识扩展（六） TS 完全指南之知识扩展（六） TS 完全指南之知识扩展（六）

tsconfig.json

  • 通过 tsc --init 命令可以生成 tsconfig.json
  • 它是 TS 的配置文件，用于配置 TS 编译器的行为
"compilerOptions": {
"incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件，第二次编译会在第一次的基础上进行增量编译，可以提高编译的速度
"tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置
"diagnostics": true, // 打印诊断信息
"target": "ES5", // 编译后的 JavaScript 代码的目标版本。例如："es5"、"es6" 等
"module": "CommonJS", // 编译后的 JavaScript 代码的模块化方案。例如："commonjs"、"es6" 等
"outFile": "./app.js", // 将多个相互依赖的文件生成一个文件，可以用在AMD模块中，即开启时应设置"module": "AMD",
"lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // 编译器需要引入的库文件。例如："es5"、"es6"、"dom" 等
"allowJS": true, // 允许编译器编译JS，JSX文件
"checkJs": true, // 允许在JS文件中报错，通常与allowJS一起使用
"outDir": "./dist", // 编译后的 JavaScript 文件输出目录
"rootDir": "./", // 指定输出文件目录(用于输出)，用于控制输出目录结构
"declaration": true, // 是否生成声明文件
"declarationDir": "./file", // 声明文件的输出目录
"emitDeclarationOnly": true, // 只生成声明文件，而不会生成js文件
"sourceMap": true, // 是否生成源代码与编译后代码的映射文件
"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 类型
"noImplicitAny": true, 是否禁止隐式的 any 类型。
"noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)
"noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)
"noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)
"noImplicitReturns": true, //每个分支都会有返回值
"esModuleInterop": true, // 允许 esmoudle 和 commonjs 相互调用
"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"
]

选项过多，讲几个常用点的：

  • target: 编译后的 JavaScript 代码的目标版本。例如："es5"、"es6" 等
  • module: 编译后的 JavaScript 代码的模块化方案。例如："commonjs"、"es6" 等
  • lib: 编译器需要引入的库文件。例如："es5"、"es6"、"dom" 等
  • allowJs: 允许编译器编译 JS，JSX 文件
  • strict: 启用所有严格类型检查选项。
  • esModuleInterop: 允许 esmoudle 和 commonjs 相互调用
  • include: 要编译的文件路径，可以是文件或文件夹的相对路径或绝对路径。
  • exclude: 不需要编译的文件路径，可以是文件或文件夹的相对路径或绝对路径
  • extends: 继承其他的 tsconfig.json 文件
  • skipLibCheck：跳过对引入的库文件的类型检查
  • sourceMap：是否生成源代码与编译后代码的映射文件
  • "removeComments"：编译文件后删除所有注释