docs: 添加validator文档

Author: renzp94

docs/.vitepress/config.ts

@@ -97,6 +97,17 @@ export default defineConfig({
         collapsed: false,
         items: [{ text: 'removeKey', link: '/object/removeKey' }],
       },
+      {
+        text: '验证器',
+        collapsed: false,
+        items: [
+          { text: 'emailValidator', link: '/validator/emailValidator' },
+          { text: 'idCardValidator', link: '/validator/idCardValidator' },
+          { text: 'phoneValidator', link: '/validator/phoneValidator' },
+          { text: 'telValidator', link: '/validator/telValidator' },
+          { text: 'zhValidator', link: '/validator/zhValidator' },
+        ],
+      },
       {
         text: '浏览器操作',
         collapsed: false,

docs/pages/validator/emailValidator.md

@@ -0,0 +1,36 @@
+# emailValidator
+
+邮箱验证。
+
+邮箱格式为：`username@domain.tld`。
+  - `username`是用户名。由英文字母、数字、下划线、点和中划线组成，但不能包含空格或其他特殊字符。
+  - `@`是分隔符
+  - `domain`是域名
+  - `.tld`是顶级域名
+
+
+## 基本用法
+
+传入一个字符串，如果是邮箱格式则返回`true`，否则返回`false`。
+
+```ts
+import { emailValidator } from '@renzp/utils'
+
+emailValidator('lisi@qq.com'); // true
+emailValidator('wangwu@163.com'); // true
+emailValidator('xiaoli@gmail.com'); // true
+emailValidator('lisi@qq'); // false
+```
+
+## 参数
+
+| 参数 | 说明         | 类型     | 默认值 | 是否必填 |
+| ---- | ------------ | -------- | ------ | -------- |
+| v    | 验证的字符串 | `string` | -      | 是       |
+
+
+## 返回
+
+| 参数 | 说明       | 类型      |
+| ---- | ---------- | --------- |
+| v    | 是否为邮箱 | `boolean` |

docs/pages/validator/idCardValidator.md

@@ -0,0 +1,34 @@
+# idCardValidator
+
+身份证验证。
+
+身份证组成：
+ - 前6位为省市区代码，1～2为省，3～4为市，5～6为区县
+ - 7～14位为出生年月日
+ - 15～17位为同一地址码所标示的区域范围内对同年同月同日生人编订的顺序码。第17位表示性别，奇数为男，偶数为女
+ - 18位为校验码
+
+## 基本用法
+
+传入一个字符串，如果是身份证格式则返回`true`，否则返回`false`。
+
+```ts
+import { idCardValidator } from '@renzp/utils'
+
+idCardValidator('34052419800101001X'); // true
+idCardValidator('620102195603025028'); // true
+idCardValidator('620102195603025026'); // false
+idCardValidator('abc123456789012343'); // false
+```
+
+## 参数
+
+| 参数 | 说明         | 类型     | 默认值 | 是否必填 |
+| ---- | ------------ | -------- | ------ | -------- |
+| v    | 验证的字符串 | `string` | -      | 是       |
+
+## 返回
+
+| 参数 | 说明         | 类型      |
+| ---- | ------------ | --------- |
+| v    | 是否为身份证 | `boolean` |

docs/pages/validator/phoneValidator.md

@@ -0,0 +1,29 @@
+# phoneValidator
+
+手机号验证。
+
+中国大陆手机号由11位数字组成，第1-3位为网络识别号；第4-7位为地区编码；第8-11位为用户号码。
+
+## 基本用法
+
+传入一个字符串，如果是手机号格式则返回`true`，否则返回`false`。
+
+```ts
+import { phoneValidator } from '@renzp/utils'
+
+phoneValidator('13311111111'); // true
+phoneValidator('12000000000'); // false
+```
+
+## 参数
+
+| 参数 | 说明         | 类型     | 默认值 | 是否必填 |
+| ---- | ------------ | -------- | ------ | -------- |
+| v    | 验证的字符串 | `string` | -      | 是       |
+
+
+## 返回
+
+| 参数 | 说明         | 类型      |
+| ---- | ------------ | --------- |
+| v    | 是否为手机号 | `boolean` |

docs/pages/validator/telValidator.md

@@ -0,0 +1,32 @@
+# telValidator
+
+座机号码验证。
+
+中国大陆座机号码由`区号 + 电话号码`。区号由`3~4`位组成且第一位是`0`，电话号码由`7~8`位组成。格式有：`区号-电话号码`、`(区号)电话号码`、`电话号码`。
+
+
+## 基本用法
+
+传入一个字符串，如果是座机号码格式则返回`true`，否则返回`false`。
+
+```ts
+import { telValidator } from '@renzp/utils'
+
+telValidator('010-12345678'); // true
+telValidator('(010)88050109'); // true
+telValidator('12345678'); // true
+telValidator('01100-62770334'); // false
+```
+
+## 参数
+
+| 参数 | 说明         | 类型     | 默认值 | 是否必填 |
+| ---- | ------------ | -------- | ------ | -------- |
+| v    | 验证的字符串 | `string` | -      | 是       |
+
+
+## 返回
+
+| 参数 | 说明           | 类型      |
+| ---- | -------------- | --------- |
+| v    | 是否为座机号码 | `boolean` |

docs/pages/validator/zhValidator.md

@@ -0,0 +1,41 @@
+# zhValidator
+
+是否为中文，默认匹配汉字和中文标点符号。可通过`match`参数改变匹配模式。
+
+## 基本用法
+
+传入一个字符串，如果是中文则返回`true`，否则返回`false`。
+
+```ts
+import { zhValidator } from '@renzp/utils'
+
+zhValidator('这是一段中文文字，还有中文标点符号。'); // true
+zhValidator('这是一段中文文字', ZH_MATCH.W); // true
+zhValidator('这是一段中文文字，还有中文标点符号。', ZH_MATCH.W); // false
+zhValidator('这是一段含有英文符号的字符串.'); // false
+zhValidator('《》（）', ZH_MATCH.S); // true
+```
+
+## 参数
+
+| 参数  | 说明         | 类型       | 默认值         | 是否必填 |
+| ----- | ------------ | ---------- | -------------- | -------- |
+| v     | 验证的字符串 | `string`   | -              | 是       |
+| match | 匹配模式     | `ZH_MATCH` | `ZH_MATCH.W_S` | 否       |
+
+```ts
+export enum ZH_MATCH {
+  // 匹配中文标点符号
+  S = 'symbol',
+  // 匹配汉字
+  W = 'word',
+  // 匹配汉字和中文标点符号
+  W_S = 'word_symbol',
+}
+```
+
+## 返回
+
+| 参数 | 说明       | 类型      |
+| ---- | ---------- | --------- |
+| v    | 是否为中文 | `boolean` |