一、建立自己的工具包文件夹
在文件夹中放入必要的文件:
package.json------------包管理配置文件
index.js--------------------包的入口文件
READMEmd-------------包的使用说明文档
注意:先去npm官网(npm)搜索一下是否有和自己的命名一致的包,必须保证无重复。
二、初始化package.json
给自己的包定义一些 相关的属性,比如包名,版本,描述等
{
"name": "myrc-tools",
"version": "1.0.0",
"main": "index.js",
"description": "提供了格式化时间、HTMLEscape相关的功能",
"keywords": ["rc", "dataFormat", "escape"],
"license": "ISC"
}
三、定义自己的方法
比如定义的格式化时间的方法
// 定义格式化时间的方法
function dataFormat(dtStr) {
const dt = new Date(dtStr)
const y = dt.getFullYear()
const m = padZero(dt.getMonth() + 1)
const d = padZero(dt.getDate())
const hh = padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss = padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
// 定义补零函数
function padZero(n) {
return n > 9 ? n : '0' + n
}
//向外暴露需要的成员
module.exports = {
dataFormat
}
注意一定要向外暴露所写的方法
四、入口函数index.js
const date = require('./src/dateFormat')
//向外暴露需要的成员
module.exports = {
...date,
...escape
}
引入dateFormat方法,注意要向外export成员,使用ES6中的扩展运算符可以把一个文件中有多种方法同时展现出来。
五、测试一下
// const myrc = require('./myrc-tools/index')
const myrc = require('./myrc-tools')
const dtStr = myrc.dataFormat(new Date())
console.log(dtStr);
两种require导入方法都可以实现。
注意:./myrc-tools 直接导入文件夹的链接能够实现的原因就是package.json中我们定义了main属性,通过main属性可以直接找到入口函数index.js
结果为:
成功格式化时间。
六、编写README文档