Node.js中开发属于自己的包-CSDN博客

本文链接：https://blog.csdn.net/C20001206/article/details/131544041

本文介绍了创建一个Node.js包的基本步骤，包括确定功能、设置包结构、初始化package.json、编写入口文件index.js以及如何暴露和使用方法。示例展示了如何实现时间格式化的功能，并详细解释了package.json的关键属性。

摘要由CSDN通过智能技术生成

基本步骤：

1.确定要实现的功能
2.初始包的基本结构
1.新建文件夹(包名) ，作为包的根目录
2.在包名文件夹中，新建如下三个文件
package.json (包管理配置文件)
index.js (包的入口文件)
README.md (包的说明文档)
3.初始化 package.json
package中的属性：
1.name: 表示包的名称注意：包的名称不可以重复，包名和文件夹名称没关系
2.version: 表示包的版本号
3.main: 表示包的入口文件
4.description: 包的描述信息
5.keywords: 值为数组，数组中写包的关键词
6.license: 遵循的开源许可协议

示例代码如下：（示例以格式化时间为例）

{
    "name": "zhongbeidaxue-tools",
    "version": "1.0.0",
    "main": "index.js",
    "description": "提供了格式化时间，HTMLEscape相关的功能",
    "keywords": [
        "dateFormat",
        "zhongbeidaxue",
        "escape"
    ],

    "license": "ISC"
}

4.在index.js 中定义完成的方法，并暴露出来

示例代码如下：

// 定义一个格式化时间的方法
function dateFormat(dataStr) {
    // 获取时间
    let time = new Date(dataStr)
    // 获取时间的年月日时分秒
    let y = time.getFullYear()
    let m = time.getMonth()
    let d = time.getDate()
    let hh = time.getHours()
    let mm = time.getMinutes()
    let ss = time.getSeconds()

    // 返回格式化好的字符串
    return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}

// 定义一个函数进行补0
function padZero(data) {
    return data > 9 ? data : '0' + data
}

// 暴露要给别人使用的方法
module.exports = {
    dateFormat
}

5.进行使用

示例代码如下：

// 导入使用的模块
const zhongbeidaxue = require('./zhongbeidaxue-tools')

// 使用包中的方法实现时间的格式化
let dtStr = zhongbeidaxue.dateFormat(new Date())
console.log(dtStr)