正则表达式文档增加提示

This commit is contained in:
zhangyingqi 2023-07-05 17:01:25 +08:00
parent 84393de36c
commit c45b669ba4

View File

@ -1251,46 +1251,42 @@ amis 会有默认的报错信息,如果你想自定义校验信息,配置`va
### 支持的格式校验
| 规则名称 | 说明 | 定义 | 版本 |
| ------------------------ | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | ------- |
| `isEmail` | 必须是 Email。 | `(value: any) => boolean` | |
| `isUrl` | 必须是 Url。 | `(value: any) => boolean` | |
| `isNumeric` | 必须是 数值。 | `(value: any) => boolean` | |
| `isAlpha` | 必须是 字母。 | `(value: any) => boolean` | |
| `isAlphanumeric` | 必须是 字母或者数字。 | `(value: any) => boolean` | |
| `isInt` | 必须是 整形。 | `(value: any) => boolean` | |
| `isFloat` | 必须是 浮点形。 | `(value: any) => boolean` | |
| `isLength:length` | 是否长度正好等于设定值。 | `(value: any) => boolean` | |
| `minLength:length` | 最小长度。 | `(value: any, length: number) => boolean` | |
| `maxLength:length` | 最大长度。 | `(value: any, length: number) => boolean` | |
| `maximum:number` | 最大值。 | `(value: any, maximum: number) => boolean` | |
| `minimum:number` | 最小值。 | `(value: any, minimum:number) => boolean` | |
| `equals:xxx` | 当前值必须完全等于 xxx。 | `(value: any, targetValue: any) => boolean` | |
| `equalsField:xxx` | 当前值必须与 xxx 变量值一致。 | `(value: any, field: string) => boolean` | |
| `isJson` | 是否是合法的 Json 字符串。 | `(value: any) => boolean` | |
| `isUrlPath` | 是 url 路径。 | `(value: any) => boolean` | |
| `isPhoneNumber` | 是否为合法的手机号码 | `(value: any) => boolean` | |
| `isTelNumber` | 是否为合法的电话号码 | `(value: any) => boolean` | |
| `isZipcode` | 是否为邮编号码 | `(value: any) => boolean` | |
| `isId` | 是否为身份证号码,没做校验 | `(value: any) => boolean` | |
| `matchRegexp:/foo/` | 必须命中某个正则。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `matchRegexp1:/foo/` | 必须命中某个正则。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `matchRegexp2:/foo/` | 必须命中某个正则。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `matchRegexp3:/foo/` | 必须命中某个正则。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `matchRegexp4:/foo/` | 必须命中某个正则。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `isDateTimeSame` | 日期和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeBefore` | 日期早于目标日期,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeAfter` | 日期晚于目标日期,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeSameOrBefore` | 日期早于目标日期或和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeSameOrAfter` | 日期晚于目标日期或和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeBetween` | 日期处于目标日期范围,支持指定粒度和区间的开闭形式,默认到毫秒 `millisecond`,左右开区间`'()'` | `(value: any, lhs: any, rhs: any, granularity?: string, inclusivity?: '()' \| '[)' \| '(]' \| '[]') => boolean` | `2.2.0` |
| `isTimeSame` | 时间和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeBefore` | 时间早于目标时间,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeAfter` | 时间晚于目标时间,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeSameOrBefore` | 时间早于目标时间或和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeSameOrAfter` | 时间晚于目标时间或和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeBetween` | 时间处于目标时间范围,支持指定粒度和区间的开闭形式,默认到毫秒 `millisecond`,左右开区间`'()'` | `(value: any, lhs: any, rhs: any, granularity?: string, inclusivity?: '()' \| '[)' \| '(]' \| '[]') => boolean` | `2.2.0` |
| `isVariableName` | 是否为合法的变量名,默认规则为 `/^[a-zA-Z_]+[a-zA-Z0-9]*$/` 可以自己指定如 `{isVariableName: /^a.*$/}` | `(value: any) => boolean` | `2.5.0` |
| 规则名称 | 说明 | 定义 | 版本 |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ------- |
| `isEmail` | 必须是 Email。 | `(value: any) => boolean` | |
| `isUrl` | 必须是 Url。 | `(value: any) => boolean` | |
| `isNumeric` | 必须是 数值。 | `(value: any) => boolean` | |
| `isAlpha` | 必须是 字母。 | `(value: any) => boolean` | |
| `isAlphanumeric` | 必须是 字母或者数字。 | `(value: any) => boolean` | |
| `isInt` | 必须是 整形。 | `(value: any) => boolean` | |
| `isFloat` | 必须是 浮点形。 | `(value: any) => boolean` | |
| `isLength:length` | 是否长度正好等于设定值。 | `(value: any) => boolean` | |
| `minLength:length` | 最小长度。 | `(value: any, length: number) => boolean` | |
| `maxLength:length` | 最大长度。 | `(value: any, length: number) => boolean` | |
| `maximum:number` | 最大值。 | `(value: any, maximum: number) => boolean` | |
| `minimum:number` | 最小值。 | `(value: any, minimum:number) => boolean` | |
| `equals:xxx` | 当前值必须完全等于 xxx。 | `(value: any, targetValue: any) => boolean` | |
| `equalsField:xxx` | 当前值必须与 xxx 变量值一致。 | `(value: any, field: string) => boolean` | |
| `isJson` | 是否是合法的 Json 字符串。 | `(value: any) => boolean` | |
| `isUrlPath` | 是 url 路径。 | `(value: any) => boolean` | |
| `isPhoneNumber` | 是否为合法的手机号码 | `(value: any) => boolean` | |
| `isTelNumber` | 是否为合法的电话号码 | `(value: any) => boolean` | |
| `isZipcode` | 是否为邮编号码 | `(value: any) => boolean` | |
| `isId` | 是否为身份证号码,没做校验 | `(value: any) => boolean` | |
| `matchRegexp${n}:/foo/` | 必须命中某个正则。 设置正则表达式时属性名需以 `matchRegexp` 开头,`n`支持`1-9`,且 `validations``validationsErrors` 中属性名需匹配。 | `(value: any, regexp: string \| RegExp) => boolean` | |
| `isDateTimeSame` | 日期和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeBefore` | 日期早于目标日期,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeAfter` | 日期晚于目标日期,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeSameOrBefore` | 日期早于目标日期或和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeSameOrAfter` | 日期晚于目标日期或和目标日期相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetDate: any, granularity?: string) => boolean` | `2.2.0` |
| `isDateTimeBetween` | 日期处于目标日期范围,支持指定粒度和区间的开闭形式,默认到毫秒 `millisecond`,左右开区间`'()'` | `(value: any, lhs: any, rhs: any, granularity?: string, inclusivity?: '()' \| '[)' \| '(]' \| '[]') => boolean` | `2.2.0` |
| `isTimeSame` | 时间和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeBefore` | 时间早于目标时间,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeAfter` | 时间晚于目标时间,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeSameOrBefore` | 时间早于目标时间或和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeSameOrAfter` | 时间晚于目标时间或和目标时间相同,支持指定粒度,默认到毫秒 `millisecond` | `(value: any, targetTime: any, granularity?: string) => boolean` | `2.2.0` |
| `isTimeBetween` | 时间处于目标时间范围,支持指定粒度和区间的开闭形式,默认到毫秒 `millisecond`,左右开区间`'()'` | `(value: any, lhs: any, rhs: any, granularity?: string, inclusivity?: '()' \| '[)' \| '(]' \| '[]') => boolean` | `2.2.0` |
| `isVariableName` | 是否为合法的变量名,默认规则为 `/^[a-zA-Z_]+[a-zA-Z0-9]*$/` 可以自己指定如 `{isVariableName: /^a.*$/}` | `(value: any) => boolean` | `2.5.0` |
#### 验证只允许 http 协议的 url 地址