• 周日. 11月 27th, 2022

5G编程聚合网

5G时代下一个聚合的编程学习网

热门标签

深入理解TypeScript(未完)

admin

11月 28, 2021

https://jkchao.github.io/typescript-book-chinese/#why

  • 疑问:基于TypeScript 2.4

编译上下文

  • 在项目的根目录下创建一个空 JSON 文件tsconfig.json。通过这种方式,TypeScript 将 会把此目录和子目录下的所有 .ts 文件作为编译上下文的一部分,它还会包含一部分默认的编译选项。
{
  "compilerOptions": {

    /* 基本选项 */
    "target": "es5",                       // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', 'ES6'/'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'(注释:编译后代表兼容的es版本)
    "module": "commonjs",                  // 指定使用模块: 'commonjs', 'amd', 'system', 'umd' or 'es2015'(注释:编译后的模块组织方式)
    "lib": [],                             // 指定要包含在编译中的库文件
    "allowJs": true,                       // 允许编译 javascript 文件
    "checkJs": true,                       // 报告 javascript 文件中的错误
    "jsx": "preserve",                     // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
    "declaration": true,                   // 生成相应的 '.d.ts' 文件
    "sourceMap": true,                     // 生成相应的 '.map' 文件
    "outFile": "./",                       // 将输出文件合并为一个文件
    "outDir": "./",                        // 指定输出目录
    "rootDir": "./",                       // 用来控制输出目录结构 --outDir.
    "removeComments": true,                // 删除编译后的所有的注释
    "noEmit": true,                        // 不生成输出文件
    "importHelpers": true,                 // 从 tslib 导入辅助工具函数
    "isolatedModules": true,               // 将每个文件作为单独的模块 (与 'ts.transpileModule' 类似).

    /* 严格的类型检查选项 */
    "strict": true,                        // 启用所有严格类型检查选项
    "noImplicitAny": true,                 // 在表达式和声明上有隐含的 any类型时报错
    "strictNullChecks": true,              // 启用严格的 null 检查
    "noImplicitThis": true,                // 当 this 表达式值为 any 类型的时候,生成一个错误
    "alwaysStrict": true,                  // 以严格模式检查每个模块,并在每个文件里加入 'use strict'

    /* 额外的检查 */
    "noUnusedLocals": true,                // 有未使用的变量时,抛出错误
    "noUnusedParameters": true,            // 有未使用的参数时,抛出错误
    "noImplicitReturns": true,             // 并不是所有函数里的代码都有返回值时,抛出错误
    "noFallthroughCasesInSwitch": true,    // 报告 switch 语句的 fallthrough 错误。(即,不允许 switch 的 case 语句贯穿)

    /* 模块解析选项 */
    "moduleResolution": "node",            // 选择模块解析策略: 'node' (Node.js) or 'classic' (TypeScript pre-1.6)
    "baseUrl": "./",                       // 用于解析非相对模块名称的基目录
    "paths": {},                           // 模块名到基于 baseUrl 的路径映射的列表
    "rootDirs": [],                        // 根文件夹列表,其组合内容表示项目运行时的结构内容
    "typeRoots": [],                       // 包含类型声明的文件列表
    "types": [],                           // 需要包含的类型声明文件名列表
    "allowSyntheticDefaultImports": true,  // 允许从没有设置默认导出的模块中默认导入。

    /* Source Map Options */
    "sourceRoot": "./",                    // 指定调试器应该找到 TypeScript 文件而不是源文件的位置
    "mapRoot": "./",                       // 指定调试器应该找到映射文件而不是生成文件的位置
    "inlineSourceMap": true,               // 生成单个 soucemaps 文件,而不是将 sourcemaps 生成不同的文件
    "inlineSources": true,                 // 将代码与 sourcemaps 生成到一个文件中,要求同时设置了 --inlineSourceMap 或 --sourceMap 属性

    /* 其他选项 */
    "experimentalDecorators": true,        // 启用装饰器
    "emitDecoratorMetadata": true          // 为装饰器提供元数据的支持
  }
}
  • 从命令行手动运行 TypeScript 编译器
    • 运行 tsc,它会在当前目录或者是父级目录寻找 tsconfig.json 文件。
    • 运行 tsc -p ./path-to-project-directory 。当然,这个路径可以是绝对路径,也可以是相对于当前目录的相对路径。
    • 可以使用 tsc -w 来启用 TypeScript 编译器的观测模式,在检测到文件改动之后,它将重新编译。
  • 可以显式指定需要编译的文件
{
  "files": [
    "./some/file.ts"
  ]
}
  • 可以使用 include 和 exclude 选项来指定需要包含的文件和排除的文件
{
  "include": [
    "./folder"
  ],
  "exclude": [
    "./folder/**/*.spec.ts",
    "./folder/someSubFolder"
  ]
}
  • / (一个示例用法:some/folder/*/*)意味着匹配所有的文件夹和所有文件(扩展名为 .ts/.tsx,当开启了 allowJs: true 选项时,扩展名可以是 .js/.jsx)。

模块

  • 当你开始在一个新的 TypeScript 文件中写下代码时,它处于全局命名空间中
    • 如果在你的 TypeScript 文件的根级别位置含有 import 或者 export,那么它会在这个文件中创建一个本地的作用域。
  • export 的写法
export { someVar, someType }; // 注释:等价于 export someVar 和 export someType
export { someVar as aDifferentName };
export * from './foo';
export { someVar } from './foo';
export { someVar as aDifferentName } from './foo';
  • 默认导入/导出
export default (someVar = 123);
  • 使用了 module: commonjs 选项, moduleResolution: node 将会默认开启

  • 当你使用 import * as foo from ‘something/foo’,将会逐层向上查找内容./node_modules/something/foo,直至系统的根目录(注释:查找库对应的类型)

    • 注释:在查找的文件夹下的 package.json 文件中可以指定 types 的文件,指明类型文件的所在
    • 注释:也可以指定 main 的文件,一般为 ts 文件,指明类型文件的来源
  • 在你的项目里,你可以通过 declare module ‘somePath’ 声明一个全局模块的方式

// global.d.ts
declare module 'foo' {
  // some variable declarations
  export var bar: number;
}
  • 注释:module 和 namespace 编译的结果是一致的
module czb {
  export const a = 1
}
// 编译后
var czb;
(function (czb) {
    czb.a = 1;
})(czb || (czb = {}));
  • 如果你仅仅是 import/require (导入)一些并没有与你的模块或者模块加载器有任何依赖的 JavaScript 代码,(如:webpack),经过 TypeScript 编译后,这些将会被完全忽视。在这种情况下,你可以使用一个 ensureImport 变量,来确保编译的 JavaScript 依赖与模块。
import foo = require('./foo');
import bar = require('./bar');
import bas = require('./bas');

const ensureImport: any = foo || bar || bas;

命名空间

  • 命名空间是支持嵌套的
namespace Utility {
  const a = '1'
  export function log(msg: string) {
    console.log(msg + a);
  }
}
// 编译后
var Utility;
(function (Utility) {
    var a = '1';
    function log(msg) {
        console.log(msg + a);
    }
    Utility.log = log;
})(Utility || (Utility = {}));

动态导入表达式

  • 使用 “module”: “esnext” 选项:TypeScript 保留 import() 语句,该语句用于 Webpack Code Splitting(代码分割)。
{
  "compilerOptions": {
    "target": "es5",
    "module": "esnext",
    "lib": [
      "dom",
      "es5",
      "scripthost",
      "es2015.promise"
    ],
    "jsx": "react",
    "declaration": false,
    "sourceMap": true,
    "outDir": "./dist/js",
    "strict": true,
    "moduleResolution": "node",
    "typeRoots": [
      "./node_modules/@types"
    ],
    "types": [
      "node",
      "react",
      "react-dom"
    ]
  }
}

概览

  • 如果你需要使用类型注解的层次结构,请使用接口。它能使用 implements 和 extends

从 JavaScript 迁移

  • 为第三方库添加全局变量声明
declare type JQuery = any;
declare var $: JQuery;
  • 在 TypeScript 中,甚至可以允许你导入任何文件,例如 .css 文件(如果你使用的是 webpack 样式加载器或 css 模块),你只要添加如下代码(放在 global.d.ts):
declare module '*.css';

// html可写为
declare module '*.html';

@types

  • 默认情况下,TypeScript 会自动包含支持全局使用的任何声明定义。例如,对于 jquery,你应该能够在项目中开始全局使用 $。
  • 你可以通过配置 tsconfig.json 的 compilerOptions.types 选项,控制哪些包需要使用他的全局类型声明:
{
  "compilerOptions": {
    "types" : [
      "jquery"
    ]
  }
}

环境声明

  • 可以通过 declare 关键字来告诉 TypeScript,你正在试图表述一个其他地方已经存在的代码
    • 你可以选择把这些声明放入 .ts 或者 .d.ts 里。在你实际的项目里,我们强烈建议你应该把声明放入独立的 .d.ts 里
    • 如果一个文件有扩展名 .d.ts,这意味着每个根级别的声明都必须以 declare 关键字作为前缀。
  • 推荐尽可能的使用接口,这允许其他人扩充这些全局变量
interface Process {
  exit(code?: number): void;
}

declare let process: Process;

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注