TypeScript系列教程十《模块》

JavaScript 处理代码的模块化有很多种办法，类似于AMD CommonJS UMD 等等。TypeScript 从2012年开始，已经支持了大部分的格式，但随着时间的推移，社区和JavaScript规范已经融合到一种称为ES模块（或ES6模块）的格式上。你可能知道import/export语法。

ES Modules 2015加入JS标准，2020年大部浏览器和js运行时都支持了。

这篇文章主要介绍CommonJS和ES Modules ，Module的声明放到后面声明里学习。

 

JavaScript 模块是怎么定义的

在TypeScript中，就像在ECMAScript 2015中一样，任何包含顶级import或export的文件都被视为一个模块。

相反，没有任何顶级导入或导出声明的文件被视为脚本，其内容在全局范围内可用（因此也适用于模块）。

模块在其自身范围内执行，而不是在全局范围内执行。这意味着模块中声明的变量、函数、类等在模块外不可见，除非使用其中一种导出形式显式导出它们。相反，要使用从不同模块导出的变量、函数、类、接口等，必须使用其中一种导入表单进行导入。

非模块

在开始之前，了解TypeScript认为模块是什么很重要。JavaScript规范声明，任何没有导出或顶级等待的JavaScript文件都应该被视为脚本，而不是模块。

在脚本文件中，变量和类型被声明为在共享全局范围内，并且假设您将使用–outFile编译器选项将多个输入文件连接到一个输出文件中，或者在HTML中使用多个

如果您的文件当前没有任何导入或导出，但希望将其视为模块，请添加以下行：

export {};

这会将文件更改为不导出任何内容的模块。无论您的模块目标是什么，此语法都有效。

 

TypeScript 中的模块

在TypeScript编写基于模块的代码时，需要考虑三个主要问题：

• 语法: 我想使用什么语法来导入和导出内容？
• 模块解析： 模块名称（或路径）与磁盘上的文件之间的关系是什么？
• 模块输出目标： 我发出的JavaScript模块应该是什么样子？

ES Module 语法

文件可以通过export default声明主导出：

// @filename: hello.ts
export default function helloWorld() {
  console.log("Hello, world!");
}

然后通过以下方式导入：

import hello from "./hello.js";
hello();

除了默认导出外，您还可以通过导出进行多个变量和函数的导出，方法是省略默认值：

// @filename: maths.ts
export var pi = 3.14;
export let squareTwo = 1.41;
export const phi = 1.61;
 
export class RandomNumberGenerator {}
 
export function absolute(num: number) {
  if (num < 0) return num * -1;
  return num;
}

可以通过导入语法在另一个文件中使用：

import { pi, phi, absolute } from "./maths.js";
 
console.log(pi);
const absPhi = absolute(phi);
        
//const absPhi: number

附加导入语法

可以使用类似import{old as new}的格式重命名导入：

import { pi as π } from "./maths.js";
 
console.log(π);
           
//(alias) var π: number
//import π

您可以将上述语法混合并匹配到单个导入中：

// @filename: maths.ts
export const pi = 3.14;
export default class RandomNumberGenerator {}
 
// @filename: app.ts
import RNGen, { pi as π } from "./maths.js";
 
RNGen;
 
//(alias) class RNGen
//import RNGen
 
console.log(π);
           
//(alias) const π: 3.14
//import π

您可以使用*作为名称，获取所有导出的对象并将它们放入单个命名空间中：

// @filename: app.ts
import * as math from "./maths.js";
 
console.log(math.pi);
const positivePhi = math.absolute(math.phi);
          
const positivePhi: number

您可以通过导入“/file”导入文件，而不将任何变量包含到当前模块中：

// @filename: app.ts
import "./maths.js";
 
console.log("3.14");

在本例中，导入不执行任何操作。然而，Math.ts中的所有代码都经过了评估，这可能会引发影响其他对象的副作用。

TypeScript 中特殊的ES Module语法

可以使用与JavaScript值相同的语法导出和导入类型：

// @filename: animal.ts
export type Cat = { breed: string; yearOfBirth: number };
 
export interface Dog {
  breeds: string[];
  yearOfBirth: number;
}
 
// @filename: app.ts
import { Cat, Dog } from "./animal.js";
type Animals = Cat | Dog;

TypeScript使用import type扩展了导入语法，该导入类型是只能导入类型的导入。

// @filename: animal.ts
export type Cat = { breed: string; yearOfBirth: number };
'createCatName' cannot be used as a value because it was imported using 'import type'.
export type Dog = { breeds: string[]; yearOfBirth: number };
export const createCatName = () => "fluffy";
 
// @filename: valid.ts
import type { Cat, Dog } from "./animal.js";
export type Animals = Cat | Dog;
 
// @filename: app.ts
import type { createCatName } from "./animal.js";
const name = createCatName();

此语法允许像Babel、swc或esbuild这样的非类型脚本传输程序知道哪些导入可以安全删除。

具有CommonJS行为的ES模块语法

TypeScript具有ES模块语法，该语法直接与CommonJS和AMD请求相关。在大多数情况下，使用ES模块的导入与来自这些环境的需求相同，但此语法确保您的TypeScript文件与CommonJS输出具有1对1的匹配：

import fs = require("fs");
const code = fs.readFileSync("hello.ts", "utf8");

CommonJS 语法

CommonJS是npm上大多数模块的交付格式。即使您正在使用上面的ES模块语法进行编写，简单了解CommonJS语法的工作原理也将帮助您更轻松地进行调试。

Exporting

标识符是通过在名为module的全局上设置exports属性导出的。

function absolute(num: number) {
  if (num < 0) return num * -1;
  return num;
}
 
module.exports = {
  pi: 3.14,
  squareTwo: 1.41,
  phi: 1.61,
  absolute,
};

然后可以通过require语句导入这些文件：

const maths = require("maths");
//maths.pi;
      
//any

或者，您可以使用JavaScript中的解构功能简化一点：

const { squareTwo } = require("maths");
squareTwo;
   
//const squareTwo: any

CommonJS和ES模块互操作

CommonJS和ES模块之间的功能不匹配，因为ES模块只支持将默认导出作为对象，而不支持将其作为函数。TypeScript有一个编译器标志，用于通过esModuleInterop减少两组不同约束之间的摩擦。

TypeScript的模块解析选项

模块解析是从import或require语句中获取字符串，并确定该字符串引用的文件的过程。

TypeScript包括两种解析策略：Classic和Node。Classic是编译器标志模块不是commonjs时的默认设置，用于向后兼容。Node策略复制Node.js在CommonJS模式下的工作方式，并对.ts和.d.ts进行额外检查。

在TypeScript中有许多影响模块策略的TSConfig标志：moduleResolution、baseUrl、path、rootDirs。

有关这些策略如何工作的详细信息，请参阅模块解析。

TypeScript的模块输出选项

有两个选项会影响发出的JavaScript输出：

• target: 编译JS标准，比如ES5 / ES6等
• module ： 打包成模块的模式，比如AMD/ES/UMD等

您使用的目标由您希望在其中运行TypeScript代码的JavaScript运行时中可用的特性决定。这可能是：您支持的最早的web浏览器，您希望在其上运行的Node.js的最低版本，或者可能来自运行时的唯一约束，例如Electron。

模块之间的所有通信都通过模块加载器进行，编译器标志模块确定使用哪个模块。在运行时，模块加载器负责在执行模块之前定位和执行模块的所有依赖项。

例如，下面是一个使用ES模块语法的TypeScript文件，展示了模块的几个不同选项：

import { valueOfPi } from "./constants.js";
export const twoPi = valueOfPi * 2;

ES2020

import { valueOfPi } from "./constants.js";
export const twoPi = valueOfPi * 2;

CommonJS

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.twoPi = void 0;
const constants_js_1 = require("./constants.js");
exports.twoPi = constants_js_1.valueOfPi * 2;

UMD

(function (factory) {
    if (typeof module === "object" && typeof module.exports === "object") {
        var v = factory(require, exports);
        if (v !== undefined) module.exports = v;
    }
    else if (typeof define === "function" && define.amd) {
        define(["require", "exports", "./constants.js"], factory);
    }
})(function (require, exports) {
    "use strict";
    Object.defineProperty(exports, "__esModule", { value: true });
    exports.twoPi = void 0;
    const constants_js_1 = require("./constants.js");
    exports.twoPi = constants_js_1.valueOfPi * 2;
});

可以在TSConfig 查看编译成JavaScript的配置

TypeScript 命名空间

TypeScript有自己的名为名称空间的模块格式，它早于ES模块标准。该语法具有许多用于创建复杂定义文件的有用功能，并且在DefiniteTyped中仍有积极的用途。虽然名称空间中的大多数特性都存在于ES模块中，但我们建议您使用这些特性来与JavaScript的方向保持一致。您可以在名称空间参考页面中了解有关命名空间的更多信息。