如何写NodeJs模块

  1. 遵守CommonJS规范。
    • 导入模块
    • 暴露出去(导出)

一个简单的示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
// 定义一个对象
let db = {
baseUrl: "http://127.0.0.1:3000/",
insert: function () {
console.log("插入方法");
},
delete: function () {
console.log("删除方法");
},
};
// 将其暴露出去
module.exports = db;

在我们的模块中定义一个对象,并将其暴露出去。接下来在我们自己的js文件中去使用这个对象。

1
2
const myMoudle = require("./01-自己写的模块.js");
myMoudle.insert();

image-20200704183311332

写一个自己的模块

NPM发布包

  1. 进入待发布的目录,然后初始化目录npm init。并依次填入包名版本描述等信息。如果没有可以跳过(回车)。

    image-20200704190840715

  2. 注册NPM账号

    • 官方网址注册(推荐)
    • 使用npm adduser命令注册
  3. 登录账号npm login

    image-20200704192929433

    • 如果使用了淘宝镜像须切换回官方源npm config set registry https://registry.npmjs.org/
  4. 发布包npm publish

    image-20200704192323418

    image-20200704193040051

    • 包名不能重复
    • 需要注意配置文件的main字段指定的为主文件。
    • 如果使用了淘宝镜像须切换回官方源npm config set registry https://registry.npmjs.org/
  5. 更新包

    • 修改版本

    • 重新发布

      image-20200704193537648

  6. 教程参考