https://github.com/caojianping/tsx-validator
TypeScript版本的验证器Validator，提供简单的正则、长度、大小、范围、数字、字符、日期等验证功能，同时支持验证规则的自定义扩展。
https://github.com/caojianping/tsx-validator
javascript jtps-validator typescript validate validation validator
Last synced: 3 months ago
JSON representation
TypeScript版本的验证器Validator，提供简单的正则、长度、大小、范围、数字、字符、日期等验证功能，同时支持验证规则的自定义扩展。
- Host: GitHub
- URL: https://github.com/caojianping/tsx-validator
- Owner: caojianping
- License: mit
- Created: 2019-09-03T10:08:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-30T07:39:19.000Z (about 2 years ago)
- Last Synced: 2025-01-31T04:04:18.578Z (3 months ago)
- Topics: javascript, jtps-validator, typescript, validate, validation, validator
- Language: TypeScript
- Homepage:
- Size: 8.79 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tsx-validator
TypeScript 版本的验证器 Validator，提供简单的正则、长度、大小、范围、数字、字符、日期等验证功能，同时支持验证规则的自定义扩展。
## Installing
Using npm:
```bash
$ npm install tsx-validator
```
## Example
```ts
import Validator from 'tsx-validator';
// test for validator
const key = 'test';
let username = '张三',
password = '李四',
validator = new Validator();
validator.addRule(key, { name: 'account', value: username }, { required: true }, { required: '用户名不可以为空' });
validator.addRule(key, { name: 'password', value: password }, { required: true }, { required: '密码不可以为空' });
let result = validator.execute(key);
if (!result.status) {
// 验证失败，弹出校验失败数据对象
alert(result.data);
return;
}
```
## API
##### Validator.extendRule(rules: ValidationRuleType, messages: ValidationMessageType): boolean
##### Validator.addRule(key: string, model: ValidationModelType, rules: ValidationRuleType, messages: ValidationMessageType = {}): boolean
##### Validator.addRules(key: string, options: Array): boolean
##### Validator.execute(key: string): ValidationResult
## Rule
```ts
// 规则列表
{
// 必填规则
required: any,
// 最小值规则
min: any,
// 最小值规则（排除num临界值）
minExclude: any,
// 最大值规则
max: any,
// 最大值规则（排除num临界值）
maxExclude: any,
// 值范围规则
range: any,
// 最小长度规则
minLength: any,
// 最大长度规则
maxLength: any,
// 长度范围规则
rangeLength: any,
// 最小日期规则
minDate: any,
// 最大日期规则
maxDate: any,
// 选择规则
checked: any,
// 相等规则
equal: any,
//不相等规则
unequal: any,
// 手机号码规则
mobile: any,
// 邮箱规则
email: any,
// 格式化规则
format: any
}
```