NodeJS模块【简单说明】

nodejs模块【简单说明】

什么是模块？

假设您的 nodejs 项目中有一个 index.js 文件，您在其中使用了五个函数。但是，其中两个函数也可能在其他文件中使用。因此，您在项目中创建了三个文件，而不是一个文件：

index.js
dependency1.js
dependency2.js

这里，每个javascript文件都是一个模块，导出类/函数和导入它们的方式基本上是模块系统。模块系统允许我们拆分和包含代码，并在需要时导入我们或其他开发人员编写的代码。

这些模块不仅仅是项目中存在的 javascript 文件；它们也可以是您在项目中作为依赖项安装的任何外部包。另外，nodejs 有一些内置模块，如 http、fs 等，这些模块可以随安装一起使用，并且可以在不添加任何外部依赖项的情况下导入。

如何导出或导入模块？

node.js 中使用了两个模块系统。

commonjs (cjs)
ecmascript 模块 (esm)

您已经阅读了我之前博客中的厨房-厨师-服务员示例；同样，如果我们将模块与此进行比较，想象 commonjs 是一本古老的大食谱书，我们需要搜索和查找食谱，而 esm 是一个新的老式数字应用程序来查看食谱。

commonjs (cjs)

旧的模块系统。
模块以简单的格式编写，例如：

// export
module.exports = function sayhello() {
  console.log("hello world!");
};

// import
const gethello = require("./hello-script.js");
sayhello(); // "hello world!"

同步：依次加载模块。
仅在 node.js 中工作（不能直接在浏览器中工作）。

ecmascript 模块 (esm)

现代模块系统。
模块现在更加结构化：

// export
export function sayhello() {
  console.log("hello world!");
}

// import
import { sayhello } from "./hello-script.js";
sayhello();

异步：同时加载多个模块。
在浏览器和 node.js 中原生工作。

语法上的主要区别：
cjs： module.exports / require
esm：导出/导入

如何在我的项目中配置 cjs 或 esm？

打开项目的package.json。
添加：

{
  type: "module";
}

这告诉 nodejs 将 .js 解释为 esm。如果我们不添加这个，nodejs 将默认将其解释为 commonjs。

typescript 中的模块：

有时，您可以使用 ecmascript 模块，但您导入的旧包是用 commonjs 编写的。为了处理这些情况，我们有时会确保从 typescript 文件生成的输出 javascript 代码采用通用格式，即使我们已经以 esm 格式编写了 typescript 文件。

为此，我们在项目的 tsconfig.json 中添加编译器选项：

"compileroptions": {
  "module": "commonjs",
  "target": "es6"
}

然后会发生什么：
module: "commonjs"：使用 commonjs 模块系统输出 javascript，该系统使用 require 和 module.exports。
target: "es6"：确保输出 javascript 使用 es6 语法和 let、const 和箭头函数等功能。

输入打字稿代码：

import { readfile } from "fs";

const sayhello = () => {
  console.log("hello world!");
};

export { sayhello };

输出javascript代码：

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SayHello = void 0;
const fs_1 = require("fs");
const SayHello = () => {
    console.log("Hello World!");
};
exports.SayHello = SayHello;

以上就是NodeJS模块【简单说明】的详细内容，更多请关注硕下网其它相关文章！