创建Node.js模块

创建Node.js模块

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

创建一个package.json文件

  1. 要创建package.json文件,请在命令行上的Node.js模块的根目录中运行npm init:

  • 对于作用域模块,运行npm init --scope=@scope-name

  • 对于无作用域的模块,运行npm init

  • 提供必填字段(name和version)以及字段的响应main:

    • name:模块的名称。

    • version:初始模块版本。我们建议您遵循语义版本控制指南,并从开始1.0.0。

    • main:当另一个应用程序需要您的模块时将加载的文件的名称。默认名称是index.js。

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

    一旦你的package.json文件被创建,创建所需的模块时,将加载该文件。该文件的默认名称是index.js。

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

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

    测试您的模块

    1. 将软件包发布到npm:

    • 对于私有软件包和无作用域的软件包,请使用npm publish。

    • 对于有范围的公共软件包,请使用npm publish --access public

  • 在命令行上,在项目目录之外创建一个新的测试目录。

    mkdir test-directory
  • 切换到新目录:

    cd /path/to/test-directory
  • 在测试目录中,安装模块:

    npm install <your-module-name>
  • 在测试目录中,创建一个test.js文件,该文件需要您的模块并将其作为方法调用。

  • 在命令行上,运行node test.js。发送到console.log的消息应该出现。