11、创建Node.js模块

Node.js模块是一种可以发布到npm的包。当你创建一个新模块的时候,你将从 package.json 文件开始。

使用 npm init 命令创建 package.json 文件。命令行中将会弹出package.json字段中要你输入的值。两个必填字段:名称(name)和版本(version)。你可能也需要输入主文件字段(main),可以使用默认值 index.js

如果你想为作者(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. 在你的项目外新建一个目录,然后 cd 过去
  3. 运行 npm install <package>
  4. 创建一个test.js文件,require这个包,并调用此方法(函数)
  5. 运行 node test.js。终端将会输出:This is a message from the demo package

恭喜你,你的第一个npm包创建成功了。

文章导航