@sumor/base
轻呈云基础库,可用于浏览器、Node.JS等
安装
通过 npm 安装:
$ npm install --save @sumor/base
使用说明
ES6方式
//例如要访问的程序路径为level1.level2.level3
import {level1} from '@sumor/base';
level1.level2.level3('parameter1');
Node.js CommonJS方式
//例如要访问的程序路径为level1.level2.level3
const {level1} = require('@sumor/base');
level1.level2.level3('parameter1');
接口文档
caller(func, meta, context) 程序格式化调用器
类型
同步函数
参数
-
func
<Function>
目标函数 (必填项) -
meta
<Object>
主数据 -
context
<Object>
交互上下文
new data.Entity(definition) 实体
通过实体可定义多个属性,并校验和格式化对象数据
类型
类
参数
-
definition
<Object>
定义信息 (必填项)
new data.Property(definition) 属性
通过属性可定义数据格式要求,并校验和格式化单个数据
类型
类
参数
-
definition
<Object>
定义信息 (必填项)
new data.Rule(definition) 规则
通过规则可校验数据
类型
类
参数
-
definition
<Object>
定义信息 (必填项)
await delay(sec) 延时器
异步延时器,可使用await语法同步执行使程序延时N秒
类型
异步函数
参数
-
sec
<Number>
延时秒数 (必填项)
new Error(name, message) 错误信息
类型
类
参数
-
name
<String>
错误名称 (必填项) 技术名称,仅支持字母数字及下划线 -
message
<String>
错误信息 错误详细信息,将返回给最终用户
formatTime(timestamp, format, timezone) 时间格式化
类型
同步函数
参数
-
timestamp
<Number>
时间戳 (必填项) -
format
<String>
格式 (必填项) 如:yyyy-MM-dd hh:mm:ss -
timezone
<String>
时区分钟数偏移量 默认当前时区,例如:切换至UTC+2,该字段设为120
getTimestamp() 获取当前时间戳
类型
同步函数
name.object.toPath(route, suffix) 对象地址转路径
类型
同步函数
参数
-
route
<String>
路径 (必填项) -
suffix
<String>
后缀名
name.path.basename(path,suffix) 获取文件名
类型
同步函数
参数
-
path
<String>
路径 (必填项) -
suffix
<String>
后缀名
name.path.dirname(path) 获取所在目录
类型
同步函数
参数
-
path
<String>
路径 (必填项)
name.path.extname(path) 获取文件后缀
类型
同步函数
参数
-
path
<String>
路径 (必填项)
name.path.isAbsolute(path) 判断是否为绝对路径
类型
同步函数
参数
-
path
<String>
路径 (必填项)
name.path.join(paths) 路径合并
合并多个路径
类型
同步函数
参数
-
paths
<Array>
路径列表 (必填项)
name.path.normalize(path) 简化格式化路径
类型
同步函数
参数
-
path
<String>
路径 (必填项)
name.path.resolve(paths) 路径合并
合并多个路径,如有绝对路径则以最后一个绝对路径为准
类型
同步函数
参数
-
paths
<Array>
路径列表 (必填项)
name.path.toObject(route, suffix) 路径转对象地址
类型
同步函数
参数
-
route
<String>
路径 (必填项) -
suffix
<String>
后缀名
name.string.fromCamelCase(text, spliter) 驼峰转横线格式字符串
类型
同步函数
参数
-
text
<String>
文本 (必填项) -
spliter
<String>
分隔符
name.string.fromNPM(name) NPM包名转驼峰
类型
同步函数
参数
-
name
<String>
名称 (必填项)
name.string.toCamelCase(text, spliter, lower) 横线转驼峰格式字符串
类型
同步函数
参数
-
text
<String>
文本 (必填项) -
spliter
<String>
分隔符 -
lower
<Boolean>
是否为小写驼峰
name.string.toNPM(name) 驼峰转NPM包名
类型
同步函数
参数
-
name
<String>
名称 (必填项)
number.from10to36(parameters)
类型
同步函数
number.from10to62(parameters)
类型
同步函数
number.from36to10(parameters)
类型
同步函数
number.from62to10(parameters)
类型
同步函数
object.clone(target) 克隆对象
类型
同步函数
参数
-
target
<Object>
目标对象
object.get(target,path) 根据路径读取对象数据
类型
同步函数
参数
-
target
<Object>
目标对象 -
path
<String>
目标路径
object.set(target,path,value) 根据路径写入对象数据
类型
同步函数
参数
-
target
<Object>
目标对象 -
path
<String>
目标路径 -
value
<Any>
数据
object.toPath(target) 转路径格式对象
类型
同步函数
参数
-
target
<Object>
目标对象
path.generateIndex(parameters)
类型
同步函数
random(length, scope) 生成随机字符串
类型
同步函数
参数
-
length
<Number>
时间戳 (必填项) -
scope
<String>
允许作为结果的字符集 默认为:ABCDEFGHIJKLMNPQRSTUVWXYZabcdefghijkmnpqrstuvwxyz23456789!@#$%^&*()+-=_
SumorError(parameters)
类型
同步函数
type(value) 查看类型
查看数据的类型,如布尔型
类型
同步函数
参数
-
value
<Any>
数据 要校验的数据