如何创建 Node.js 模块

Node.js 模块是一种可以发布到 npm 的包。当你创建一个新模块时，创建 package.json 文件是第一步。

你可以使用 npm init 命令创建 package.json 文件。命令行中将会提示 package.json 字段中需要你输入的值。名称（name） 和 版本（version） 这两个字段是必填的。你还需要输入 入口文件字段（main） 字段，当然，可以使用默认值 index.js。这些步骤在第 5 章 有详细的讲解。

如果你想为作者（author）字段添加信息，你可以使用以下格式（邮箱、网址都是选填的）：

Your Name <email@example.com> (http://example.com)

创建 package.json 文件之后，还需要创建模块的入口文件。如果使用默认值，文件名是 index.js。

在此文件中，添加一个函数，作为 exports对象的一个属性。这样，require 此文件之后，这个函数在其他代码中就可以使用了。

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

试一试：

1. 将你的包发布到 npm。
2. 在你的项目外新建一个目录。
3. 然后 cd 进入这个新目录。
4. 执行 npm install <package> 命令。
5. 创建一个 test.js 文件，require 这个包，并调用其中的方法。
6. 执行 node test.js 命令。是否输出 console.log 中填写的信息？

深入学习

To understand types of packages, click here.

Last modified February 13, 2023           Found a typo? Send a pull request!