README
丙晟 egg 统一工具包
提供使用egg框架的项目中helper的统一工具方法
安装
$ npm i bs-egg-utils
使用
app/extend/helper.js
const utils = require("bs-egg-utils");
module.exports = {
...utils
}
utils中包含以下几个方法
parallel 异步方法并行执行
await parallel(promiseArray);
parameters
参数 | 类型 | 备注 |
---|---|---|
promiseArray | Array | 支持类型 [promise,number,string,number] aysnc function 执行之后返回也是一个promise |
return
结果array
类型 | 返回值 |
---|---|
promise | 如果reject返回null |
function | 执行结果 |
string,number | 直接返回 |
example
let [rCount, payList, couponList] = await this.Helper.parallel([
this.oOrderrService.queryRefundCount(memberId, fromTime),
this.oOrderrService.queryOrderList(memberId, "10"),
this.oCouponService.getCodesList(memberId, null, null, 0)
])
ApiGet|ApiPost|ApiDelete ajax request
await ApiGet(url, data, options)
parameters
参数 | 类型 | 备注 |
---|---|---|
url | String | - |
data | Object | 请求参数 |
options | Object | request 模块的参数{ headers, json } |
formateDate 日期格式化
formateDate(format, date)
parameters
参数 | 类型 | 备注 |
---|---|---|
formate | string | moment的format,默认"YYYY-MM-DD hh:mm:ss" |
date | int | 时间戳 默认 当前时间戳 |
return
format后的时间string
md5Encrypt md5加密字符串
md5Encrypt(strToMd5)
parameters
参数 | 类型 | 备注 |
---|---|---|
strToMd5 | String | - |
return
md5 string
validate 参数校验
validate(obj, rules);
parameters
参数 | 类型 | 备注 |
---|---|---|
obj | Object | 待校验的对象 |
rules | Object | 校验规则 |
description
rules 规则 { "fieldName": options }
options字段说明
字段 | 可选值 | 备注 |
---|---|---|
type | string,number,date,boolean,object,array | - |
subType | string,number,date,boolean+自定义数据类型 | 只有当type是object的时候,这个字段才生效 |
required | true,false | 是否必选 |
validator | function | 自定义验证方法 return 类型[true,false,string] |
default | - | 默认值 |
example
var User = {
name: {
type: "string",
required: true
},
age: {
type: "number",
default: 0
},
address: {
type: "object",
subType: "User"
},
total: {
validator:function(val){
return total < 100
}
}
}