创建 Node.js 模块

Node.js 模块是包的一种类型，可以发布到 npm 上。

概述

1. 创建 package.json 文件
2. 创建在模块被其他应用程序加载时将加载的文件
3. 测试您的模块

创建 package.json 文件

1. 要创建 package.json 文件，在命令行中，在 Node.js 模块的根目录中，运行 npm init
   • 对于作用域模块，运行 npm init --scope=@scope-name
   • 对于非作用域模块，运行 npm init
2. 为必需字段 (name 和 version)，以及 main 字段提供响应
   • name: 模块的名称。
   • version: 初始模块版本。我们建议遵循语义版本控制指南，并从 1.0.0 开始。

有关 package.json 文件的更多信息，请参阅“创建 package.json 文件”。

创建在模块被其他应用程序加载时将加载的文件

在文件中，将函数作为 exports 对象的属性添加。这将使函数可用于其他代码

exports.printMsg = function() {
  console.log("This is a message from the demo package");
}

测试您的模块

1. 将您的包发布到 npm

   • 对于私有包 和非作用域包，使用 npm publish。
   • 对于作用域公共包，使用 npm publish --access public

2. 在命令行中，在您的项目目录之外创建一个新的测试目录。

   mkdir test-directory

3. 切换到新目录

   cd /path/to/test-directory

4. 在测试目录中，安装您的模块

   npm install <your-module-name>

5. 在测试目录中，创建一个 test.js 文件，该文件需要您的模块并将您的模块作为方法调用。

6. 在命令行中，运行 node test.js。发送到 console.log 的消息应出现。

资源

在 GitHub 上编辑此页面

2 贡献者

最后由 lukekarrys 编辑于 2023 年 10 月 23 日