Skip to content

Latest commit

 

History

History
180 lines (121 loc) · 4.78 KB

NEI平台系统预置的规则函数集.md

File metadata and controls

180 lines (121 loc) · 4.78 KB

NEI 平台系统预置的规则函数集

为了方便用户生成自定义的 mock 数据,NEI 平台预置了一些可以直接使用的常量和方法。为了不和用户自定义的规则函数产生冲突,它们都放在 NEI 名字空间里面。

目前NEI已支持mockjs的函数了。在NEI网站的生成规则以及规则函数的定义中可以直接使用。Mockjs支持的具体函数参考Mockjs 示例

说明: mockjs里的Random函数统一放在Mock命名空间中,即通过Mock.Random可以访问到Random中的函数。

可以使用的常量

ALPHA_NUMERIC_CHARS

数字和大小写英文字符集,它的值为:

console.log(NEI.ALPHA_NUMERIC_CHARS);
// 输出: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'

ALPHA_LOWER_CASE_CHARS

小写英文字符集,它的值为:

console.log(NEI.ALPHA_LOWER_CASE_CHARS);
// 输出: 'abcdefghijklmnopqrstuvwxyz';

NORMAL_CHINESE_CHARS

常见的中文汉字,共有 2500 个

可以调用的方法:

id()

返回一个唯一数值标识,用法:

console.log(NEI.id()); // 输出随机数值,保证在当前 mock 结果中是唯一的

str(len, min, chars)

返回一个随机字符串,参数说明:

参数名 类型 是否必需 默认值 描述
len Number 10 字符串长度,如果有 min 参数,则它表示最大长度
min Number 字符串最小长度
chars String ALPHA_NUMERIC_CHARS 字符串集

使用方法:

console.log(NEI.str()); // 输出随机字符串

chinese(len, min)

返回一个随机中文字符串,参数说明:

参数名 类型 是否必需 默认值 描述
len Number 10 需要生成的字符串长度,如果有 min 参数,则它表示最大长度
min Number 字符串最小长度

使用方法:

console.log(NEI.chinese()); // 输出随机中文字符串

email()

返回一个随机邮箱地址,参数: 无

使用方法:

console.log(NEI.email()); // 输出随机邮箱地址

url(protocol)

返回一个随机 url 地址,参数说明:

参数名 类型 是否必需 默认值 描述
protocol String http url 协议

使用方法:

console.log(NEI.url()); // 输出随机 url 地址

num(max, min)

返回一个随机数字,参数说明:

参数名 类型 是否必需 默认值 描述
max Number 100000 最大值
min Number 0 最小值

使用方法:

console.log(NEI.num()); // 输出随机数字

bool()

返回一个随机布尔值,参数: 无

使用方法:

console.log(NEI.bool()); // 输出随机布尔值

var()

返回一个随机类型的值(调用 str、num 或者 bool 方法), 它的参数会传给相应的函数

使用方法:

console.log(NEI.var()); // 输出随机类型的值

repeat(num, arrEleGenFunc, ...arrEleGenFuncArgs)

返回指定元素个数的数组。只对数组类型的参数有效。参数说明:

参数名 类型 是否必需 默认值 描述
num Number 3 生成的数组的元素个数
arrEleGenFunc Function 数组元素的生成函数

注意: arrEleGenFunc 之后的参数会传给 arrEleGenFunc 方法

使用方法:

console.log(NEI.repeat(10)); // 输出有 10 个元素的数组
console.log(NEI.repeat(10, NEI.url, 'https')); // 输出一个数组,它有 10 个元素,每个元素是一个 url 地址,并且 url 的协议是 https

loop(num, arrRepeatNum)

当存在循环引用的时候(比如树型结构的数据), 指定 mock 数据的生成层数。参数说明:

参数名 类型 是否必需 默认值 描述
num Number 3 指定 mock 数据的生成层数
arrRepeatNum Number 3 如果参数属性是数组, 则指定数组的元素个数

使用方法:

console.log(NEI.loop(3)); // 当存在循环引用时(比如树型结构的数据), 生成 3 层数据

null

返回 null 值

使用方法:

console.log(NEI.null());