rulev

v1.0.5

Published

2 years ago

validator for javascript, nodejs

Downloads

0High
0Medium
0Low

liaobolin

npm library template

npm 规则校验工具 ruleV

大小4kb, 其他完整的校验库太大也用不到，有点浪费
可以集成validator，做底层校验
自定义覆盖底层校验方法

安装

npm install rulev --save

使用

单个校验

import ruleV from 'rulev';

rulev.check('123456', { type: 'isMobilePhone', message: '请输入正确的手机号' });
// return { success: false, message: '请输入正确的手机号' }

校验对象

import ruleV from 'rulev';

const source = { a: 1, b: { c: '啦啦啦' } };
const ruleConfig = { 
    a: [{ type: 'isRquired', message: '值不能为空' }],
    'b.c': [
        { type: 'isRquired', message: '请输入字符' },
        { type: 'isEnglish', message: '请输入英文字符' },
    ] 
}

rulev.checkAll(source, ruleConfig);
// return { success: false, message: '请输入英文字符', checkAttr: 'b.c' }

覆盖/增强顶层校验

import ruleV from 'rulev';

ruleV.install({
    isMe(name) { return name === 'me' }
});

ruleV.check('me', { type: 'isMe' }); // true

Functions

install(enhance, override) ⇒ object

增强/覆盖校验对象，与默认校验方法合并

Kind: global function

| Param | Type | Description | | --- | --- | --- | | enhance | object | 校验方法对象 | | override | boolean | 覆盖源校验对象方法，如果有同名方法 |

getValueStepIn(attr, obj) ⇒

递进获取对象属性

Kind: global function
Returns:

| Param | Type | Description | | --- | --- | --- | | attr | string | 对象的属性 | | obj | object | 源对象 |

Example

// return 1
getValueStepIn('a.b', { a: { b: 1 } })

getValueStepIn~attrSteps

兼容 a.b 与 a[b]

Kind: inner constant of getValueStepIn

check(value, rules, [checkAttr], [source], errReturnWay) ⇒ object

单个值校验

Kind: global function
Returns: object - { success: true, message: '', checkAttr, }

| Param | Type | Description | | --- | --- | --- | | value | string | 需要校验的值 | | rules | array | 校验规则数组 | | [checkAttr] | string | 需要被校验的属性(可选), type为自定义校验方法时可用 | | [source] | object | 属性的源对象(可选) , type为自定义校验方法时可用 | | errReturnWay | boolean | 校验失败返回方式 message|boolean|错误对象 |

checkAll(source, ruleConfig, immediately, errReturnWay) ⇒ array

根据属性配置进行批量校验

Kind: global function
Returns: array - [ { success: false, message: '请输入正确的手机号码', checkAttr: 'user.mobile', } ]

| Param | Type | Default | Description | | --- | --- | --- | --- | | source | object | | 需要校验的属性的源对象 | | ruleConfig | object | | 需要校验的属性与校验规则数组的配置对象 | | immediately | boolean | true | 校验第一个错误立即停止返回 | | errReturnWay | boolean | | 校验失败返回方式 message|boolean|错误数组 |

Example

checkAll({ user: { mobile: '12345' } }, { 'user.mobile': [ { type: 'isRequired', message: '请输入手机号码' }, { type: 'isMobilePhone', message: '请输入正确的手机号码' } ] })

is(value, rule) ⇒ boolean

正则校验值

Kind: global function

| Param | Type | Description | | --- | --- | --- | | value | string | 需要校验的值 | | rule | object | 校验规则 reg || { reg: /xxx/ } |