Creating Node.js modules

Node.js模块是一种可以发布到npm的软件包 .

Overview

  1. Create a package.json file
  2. Create the file that will be loaded when your module is required by another application
  3. Test your module

Create a package.json file

  1. 要创建package.json文件,请在命令行上的Node.js模块的根目录中,运行npm init
  2. 提供必填字段( nameversion )以及main字段的响应:
    • name :模块的名称.
    • version :初始模块版本. 我们建议遵循语义版本控制准则,并从1.0.0开始.
    • main :当另一个应用程序需要您的模块时将加载的文件的名称. 默认名称为index.js .

有关package.json文件的更多信息,请参见" 创建package.json文件 ".

Create the file that will be loaded when your module is required by another application

创建package.json文件后,创建将在需要模块时加载的文件. 该文件的默认名称是index.js .

在文件中,添加一个函数作为exports对象的属性. 这将使该功能可用于其他代码:

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

Test your module

  1. 将软件包发布到npm:
  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的消息应该出现.

Resources


< Creating a package.json file | About package README files >

by  ICOPY.SITE