文档更新,以及兼容性更新

api.md

@@ -3,37 +3,8 @@
 <dl>
 <dt><a href="#FieldCheck">FieldCheck</a></dt>
 <dd></dd>
-<dt><a href="#FieldCheck">FieldCheck</a></dt>
-<dd></dd>
-<dt><a href="#FormItem">FormItem</a></dt>
-<dd><p>FormItem 表单验证类</p>
-</dd>
-</dl>
-
-## Typedefs
-
-<dl>
-<dt><a href="#errMessage">errMessage</a> : <code>string</code></dt>
-<dd><p>错误信息</p>
-</dd>
-<dt><a href="#checkFields">checkFields</a> : <code>Array.&lt;(string|RegExp)&gt;</code></dt>
-<dd><p>验证字段匹配项</p>
-</dd>
-<dt><a href="#checkRule">checkRule</a> : <code>Object</code></dt>
-<dd><p>规则对象</p>
-</dd>
-<dt><a href="#validatorFunction">validatorFunction</a> ⇒ <code>string</code></dt>
-<dd><p>自定义验证函数</p>
-</dd>
-<dt><a href="#ruleItem">ruleItem</a> : <code>Object</code></dt>
-<dd><p>验证规则对象</p>
-</dd>
-<dt><a href="#checkCode">checkCode</a> : <code>number</code></dt>
-<dd><p>验证码</p>
-</dd>
-<dt><a href="#formItemData">formItemData</a> : <code>object</code></dt>
-<dd><p>表单项数据</p>
-</dd>
+<dt><a href="#FormVerify">FormVerify</a></dt>
+<dd><p>FormItem 表单验证类</p></dd>
 </dl>
 
 <a name="FieldCheck"></a>
@@ -44,385 +15,192 @@
 
 | Name | Type | Description |
 | --- | --- | --- |
-| ruleItems | [<code>Array.&lt;ruleItem&gt;</code>](#ruleItem) | 验证规则 |
-| addRuleItem | <code>function</code> | 添加一条验证规则 |
-| verify | <code>function</code> | 检查表单是否符合规则 |
+| ruleItems | <code>Array.&lt;ruleItem&gt;</code> | <p>验证规则</p> |
+| addRuleItem | <code>function</code> | <p>添加一条验证规则</p> |
+| verify | <code>function</code> | <p>检查表单是否符合规则</p> |
 
 
 * [FieldCheck](#FieldCheck)
     * [new FieldCheck()](#new_FieldCheck_new)
-    * [new FieldCheck([ruleItems])](#new_FieldCheck_new)
-    * [._isEmpty(v)](#FieldCheck+_isEmpty) ⇒ <code>boolean</code>
-    * [.buildRuleItem(checkFields, ruleArr)](#FieldCheck+buildRuleItem) ⇒ [<code>ruleItem</code>](#ruleItem)
-    * [.addRuleItem(ruleName, checkFields, ruleArr)](#FieldCheck+addRuleItem) ⇒ [<code>FieldCheck</code>](#FieldCheck)
-    * [.getRuleItem(field)](#FieldCheck+getRuleItem) ⇒ [<code>ruleItem</code>](#ruleItem)
-    * [.checkField(field, value)](#FieldCheck+checkField) ⇒ <code>Array.&lt;(checkCode\|errMessage)&gt;</code>
-    * [.verify(formObject, [isMustMatch])](#FieldCheck+verify) ⇒ [<code>errMessage</code>](#errMessage)
+    * [._isEmpty(v)](#FieldCheck+_isEmpty)
+    * [._isRegExp(v)](#FieldCheck+_isRegExp)
+    * [.buildRuleItem(checkFields, ruleArr)](#FieldCheck+buildRuleItem) ⇒ <code>ruleItem</code>
+    * [.addRuleItem(ruleName, checkFields, ruleArr)](#FieldCheck+addRuleItem) ⇒
+    * [.getRuleItem(field)](#FieldCheck+getRuleItem) ⇒
+    * [.checkField(field, value)](#FieldCheck+checkField) ⇒ <code>Array.&lt;(checkCode\|?errMessage)&gt;</code>
+    * [.verify(formObject, [isMustMatch])](#FieldCheck+verify) ⇒
 
 <a name="new_FieldCheck_new"></a>
 
 ### new FieldCheck()
-表单字段验证类
+<p>表单字段验证类</p>
 
 **Example**  
 ```js
 let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
   {
   type: 'string',
   minLength: 2,
   maxLength: 10,
   message: '姓名必须为2-10个字符'
   }
   ]);
   fieldCheck.addRuleItem('rule2',['age'],[
   {
   type: 'number',
   min: 18,
   max: 100,
   message: '年龄必须为18-100岁'
   }]);
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 18});
   console.log(errMsg);
   // null
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 17});
   console.log(errMsg);
   // 年龄必须为18-100岁
 ```
-<a name="new_FieldCheck_new"></a>
-
-### new FieldCheck([ruleItems])
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [ruleItems] | [<code>Array.&lt;ruleItem&gt;</code>](#ruleItem) | 验证规则数组 |
-
 <a name="FieldCheck+_isEmpty"></a>
 
-### fieldCheck.\_isEmpty(v) ⇒ <code>boolean</code>
-判断是否为空
-
-**Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-
-| Param |
-| --- |
-| v | 
-
-<a name="FieldCheck+buildRuleItem"></a>
-
-### fieldCheck.buildRuleItem(checkFields, ruleArr) ⇒ [<code>ruleItem</code>](#ruleItem)
-构建验证规则
-
-**Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>ruleItem</code>](#ruleItem) - 验证规则对象  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | 需要验证的字段 |
-| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | 验证规则 |
-
-<a name="FieldCheck+addRuleItem"></a>
-
-### fieldCheck.addRuleItem(ruleName, checkFields, ruleArr) ⇒ [<code>FieldCheck</code>](#FieldCheck)
-添加一条验证规则
-
-**Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>FieldCheck</code>](#FieldCheck) - 返回当前对象  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| ruleName | <code>string</code> | 验证规则名,用于区分 |
-| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | 用于匹配字段的字符或者正则数组 |
-| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | 验证规则 |
-
-<a name="FieldCheck+getRuleItem"></a>
-
-### fieldCheck.getRuleItem(field) ⇒ [<code>ruleItem</code>](#ruleItem)
-获取验证规则
-
-**Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>ruleItem</code>](#ruleItem) - 验证规则  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| field | <code>string</code> | 字段名 |
-
-<a name="FieldCheck+checkField"></a>
-
-### fieldCheck.checkField(field, value) ⇒ <code>Array.&lt;(checkCode\|errMessage)&gt;</code>
-检查字段是否符合规则
+### fieldCheck.\_isEmpty(v)
+<p>判断是否为空</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: <code>Array.&lt;(checkCode\|errMessage)&gt;</code> - 错误码或错误信息  
 
 | Param | Description |
 | --- | --- |
-| field | 字段名 |
-| value | 字段值 |
-
-<a name="FieldCheck+verify"></a>
-
-### fieldCheck.verify(formObject, [isMustMatch]) ⇒ [<code>errMessage</code>](#errMessage)
-检查表单是否符合规则
-
-**Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>errMessage</code>](#errMessage) - 错误码或错误信息  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| formObject | <code>Object</code> | 需要检验的表单项 字段:值 |
-| [isMustMatch] |  | 是否强制要求匹配规则 |
-
-<a name="FieldCheck"></a>
-
-## FieldCheck
-**Kind**: global class  
-
-* [FieldCheck](#FieldCheck)
-    * [new FieldCheck()](#new_FieldCheck_new)
-    * [new FieldCheck([ruleItems])](#new_FieldCheck_new)
-    * [._isEmpty(v)](#FieldCheck+_isEmpty) ⇒ <code>boolean</code>
-    * [.buildRuleItem(checkFields, ruleArr)](#FieldCheck+buildRuleItem) ⇒ [<code>ruleItem</code>](#ruleItem)
-    * [.addRuleItem(ruleName, checkFields, ruleArr)](#FieldCheck+addRuleItem) ⇒ [<code>FieldCheck</code>](#FieldCheck)
-    * [.getRuleItem(field)](#FieldCheck+getRuleItem) ⇒ [<code>ruleItem</code>](#ruleItem)
-    * [.checkField(field, value)](#FieldCheck+checkField) ⇒ <code>Array.&lt;(checkCode\|errMessage)&gt;</code>
-    * [.verify(formObject, [isMustMatch])](#FieldCheck+verify) ⇒ [<code>errMessage</code>](#errMessage)
-
-<a name="new_FieldCheck_new"></a>
-
-### new FieldCheck()
-表单字段验证类
+| v | <p>要检验的值</p> |
 
-**Example**  
-```js
-let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
   {
   type: 'string',
   minLength: 2,
   maxLength: 10,
   message: '姓名必须为2-10个字符'
   }
   ]);
   fieldCheck.addRuleItem('rule2',['age'],[
   {
   type: 'number',
   min: 18,
   max: 100,
   message: '年龄必须为18-100岁'
   }]);
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 18});
   console.log(errMsg);
   // null
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 17});
   console.log(errMsg);
   // 年龄必须为18-100岁
-```
-<a name="new_FieldCheck_new"></a>
-
-### new FieldCheck([ruleItems])
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [ruleItems] | [<code>Array.&lt;ruleItem&gt;</code>](#ruleItem) | 验证规则数组 |
-
-<a name="FieldCheck+_isEmpty"></a>
+<a name="FieldCheck+_isRegExp"></a>
 
-### fieldCheck.\_isEmpty(v) ⇒ <code>boolean</code>
-判断是否为空
+### fieldCheck.\_isRegExp(v)
+<p>判断是否为正则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 
-| Param |
-| --- |
-| v | 
+| Param | Description |
+| --- | --- |
+| v | <p>要检验的值</p> |
 
 <a name="FieldCheck+buildRuleItem"></a>
 
-### fieldCheck.buildRuleItem(checkFields, ruleArr) ⇒ [<code>ruleItem</code>](#ruleItem)
-构建验证规则
+### fieldCheck.buildRuleItem(checkFields, ruleArr) ⇒ <code>ruleItem</code>
+<p>构建验证规则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>ruleItem</code>](#ruleItem) - 验证规则对象  
+**Returns**: <code>ruleItem</code> - <p>验证规则对象</p>  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | 需要验证的字段 |
-| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | 验证规则 |
+| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | <p>需要验证的字段</p> |
+| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | <p>验证规则</p> |
 
 <a name="FieldCheck+addRuleItem"></a>
 
-### fieldCheck.addRuleItem(ruleName, checkFields, ruleArr) ⇒ [<code>FieldCheck</code>](#FieldCheck)
-添加一条验证规则
+### fieldCheck.addRuleItem(ruleName, checkFields, ruleArr) ⇒
+<p>添加一条验证规则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>FieldCheck</code>](#FieldCheck) - 返回当前对象  
+**Returns**: <p>返回当前对象</p>  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| ruleName | <code>string</code> | 验证规则名,用于区分 |
-| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | 用于匹配字段的字符或者正则数组 |
-| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | 验证规则 |
+| Param | Description |
+| --- | --- |
+| ruleName | <p>验证规则名,用于区分</p> |
+| checkFields | <p>用于匹配字段的字符或者正则数组</p> |
+| ruleArr | <p>验证规则</p> |
 
 <a name="FieldCheck+getRuleItem"></a>
 
-### fieldCheck.getRuleItem(field) ⇒ [<code>ruleItem</code>](#ruleItem)
-获取验证规则
+### fieldCheck.getRuleItem(field) ⇒
+<p>获取验证规则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>ruleItem</code>](#ruleItem) - 验证规则  
+**Returns**: <p>验证规则</p>  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| field | <code>string</code> | 字段名 |
+| Param | Description |
+| --- | --- |
+| field | <p>字段名</p> |
 
 <a name="FieldCheck+checkField"></a>
 
-### fieldCheck.checkField(field, value) ⇒ <code>Array.&lt;(checkCode\|errMessage)&gt;</code>
-检查字段是否符合规则
+### fieldCheck.checkField(field, value) ⇒ <code>Array.&lt;(checkCode\|?errMessage)&gt;</code>
+<p>检查字段是否符合规则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: <code>Array.&lt;(checkCode\|errMessage)&gt;</code> - 错误码或错误信息  
+**Returns**: <code>Array.&lt;(checkCode\|?errMessage)&gt;</code> - <p>错误码或错误信息</p>  
 
 | Param | Description |
 | --- | --- |
-| field | 字段名 |
-| value | 字段值 |
+| field | <p>字段名</p> |
+| value | <p>字段值</p> |
 
 <a name="FieldCheck+verify"></a>
 
-### fieldCheck.verify(formObject, [isMustMatch]) ⇒ [<code>errMessage</code>](#errMessage)
-检查表单是否符合规则
+### fieldCheck.verify(formObject, [isMustMatch]) ⇒
+<p>检查表单是否符合规则</p>
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
-**Returns**: [<code>errMessage</code>](#errMessage) - 错误码或错误信息  
+**Returns**: <p>errMessage 错误码或错误信息</p>  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| formObject | <code>Object</code> | 需要检验的表单项 字段:值 |
-| [isMustMatch] |  | 是否强制要求匹配规则 |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| formObject | <code>verifyForm</code> |  | <p>需要检验的表单项 字段:值</p> |
+| [isMustMatch] |  | <code>false</code> | <p>是否强制要求匹配规则</p> |
 
-<a name="FormItem"></a>
+<a name="FormVerify"></a>
 
-## FormItem
-FormItem 表单验证类
+## FormVerify
+<p>FormItem 表单验证类</p>
 
 **Kind**: global class  
 
-* [FormItem](#FormItem)
-    * [new FormItem(object, [fieldCheck], [option])](#new_FormItem_new)
+* [FormVerify](#FormVerify)
+    * [new FormVerify(formObject, [fieldCheck], [option])](#new_FormVerify_new)
     * _instance_
-        * [.fieldCheck](#FormItem+fieldCheck) : [<code>FieldCheck</code>](#FieldCheck)
-        * [.checkForm(form, isMustMatch)](#FormItem+checkForm) ⇒ <code>boolean</code>
+        * [.checkForm(form, isMustMatch)](#FormVerify+checkForm) ⇒ <code>boolean</code>
+        * [.check([isMustMatch])](#FormVerify+check)
     * _static_
-        * [.buildFormItem(object, field, formItemData, fieldCheck, isMustMatchRule)](#FormItem.buildFormItem) ⇒ <code>string</code>
-        * [.initFormItemData(formObject)](#FormItem.initFormItemData)
-
-<a name="new_FormItem_new"></a>
-
-### new FormItem(object, [fieldCheck], [option])
-表单项
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| object | <code>object</code> | 表单项数据 |
-| [fieldCheck] | [<code>FieldCheck</code>](#FieldCheck) | 字段验证对象 |
-| [option] | <code>object</code> | 配置项 |
-
-<a name="FormItem+fieldCheck"></a>
-
-### formItem.fieldCheck : [<code>FieldCheck</code>](#FieldCheck)
-字段验证对象
+        * [.buildFormItem(object, field, formItemData, fieldCheck, isMustMatchRule)](#FormVerify.buildFormItem) ⇒
+        * [.initFormItemData(formObject)](#FormVerify.initFormItemData)
 
-**Kind**: instance property of [<code>FormItem</code>](#FormItem)  
-<a name="FormItem+checkForm"></a>
+<a name="new_FormVerify_new"></a>
 
-### formItem.checkForm(form, isMustMatch) ⇒ <code>boolean</code>
-检查表单项是否符合要求
+### new FormVerify(formObject, [fieldCheck], [option])
+<p>表单项</p>
 
-**Kind**: instance method of [<code>FormItem</code>](#FormItem)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| form | <code>object</code> | 表单对象 |
-| isMustMatch |  | 是否必须全部匹配到验证规则 |
+| formObject | <code>formObject</code> | <p>表单项数据</p> |
+| [fieldCheck] | [<code>FieldCheck</code>](#FieldCheck) | <p>字段验证对象</p> |
+| [option] | <code>object</code> | <p>配置项</p> |
 
-<a name="FormItem.buildFormItem"></a>
+<a name="FormVerify+checkForm"></a>
 
-### FormItem.buildFormItem(object, field, formItemData, fieldCheck, isMustMatchRule) ⇒ <code>string</code>
-检查表单项是否符合要求
+### formVerify.checkForm(form, isMustMatch) ⇒ <code>boolean</code>
+<p>检查表单项是否符合要求</p>
 
-**Kind**: static method of [<code>FormItem</code>](#FormItem)  
-**Returns**: <code>string</code> - errMsg 错误信息  
+**Kind**: instance method of [<code>FormVerify</code>](#FormVerify)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| object | <code>object</code> | 表单项数据 |
-| field | <code>string</code> | 字段名 |
-| formItemData | [<code>formItemData</code>](#formItemData) | 表单项数据 |
-| fieldCheck | [<code>FieldCheck</code>](#FieldCheck) | 字段验证对象 |
-| isMustMatchRule | <code>boolean</code> | 表单字段是否必须匹配到验证规则 |
+| form | <code>formObject</code> | <p>表单对象</p> |
+| isMustMatch |  | <p>是否必须全部匹配到验证规则</p> |
 
-<a name="FormItem.initFormItemData"></a>
+<a name="FormVerify+check"></a>
 
-### FormItem.initFormItemData(formObject)
-初始化表单项数据
+### formVerify.check([isMustMatch])
+<p>验证当前的表单是否符合要求</p>
 
-**Kind**: static method of [<code>FormItem</code>](#FormItem)  
+**Kind**: instance method of [<code>FormVerify</code>](#FormVerify)  
 
-| Param | Type | Description |
+| Param | Default | Description |
 | --- | --- | --- |
-| formObject | <code>formObject</code> | 表单对象 |
-
-<a name="errMessage"></a>
-
-## errMessage : <code>string</code>
-错误信息
-
-**Kind**: global typedef  
-<a name="checkFields"></a>
+| [isMustMatch] | <code>false</code> | <p>是否必须全部匹配到验证规则</p> |
 
-## checkFields : <code>Array.&lt;(string\|RegExp)&gt;</code>
-验证字段匹配项
+<a name="FormVerify.buildFormItem"></a>
 
-**Kind**: global typedef  
-<a name="checkRule"></a>
+### FormVerify.buildFormItem(object, field, formItemData, fieldCheck, isMustMatchRule) ⇒
+<p>检查表单项是否符合要求</p>
 
-## checkRule : <code>Object</code>
-规则对象
+**Kind**: static method of [<code>FormVerify</code>](#FormVerify)  
+**Returns**: <p>errMsg 错误信息</p>  
 
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [type] | <code>string</code> | 类型 |
-| [min] | <code>number</code> | 最小值 |
-| [max] | <code>number</code> | 最大值 |
-| [length] | <code>number</code> | 长度 |
-| [regex] | <code>RegExp</code> | 正则表达式 |
-| [message] | [<code>errMessage</code>](#errMessage) | 错误信息 |
-| [require] | <code>boolean</code> | 是否必须 |
-| [minLength] | <code>number</code> | 最小长度 |
-| [maxLength] | <code>number</code> | 最大长度 |
-| [validator] | [<code>validatorFunction</code>](#validatorFunction) | 自定义验证函数 |
+| Param | Description |
+| --- | --- |
+| object | <p>表单项数据</p> |
+| field | <p>字段名</p> |
+| formItemData | <p>表单项数据</p> |
+| fieldCheck | <p>字段验证对象</p> |
+| isMustMatchRule | <p>表单字段是否必须匹配到验证规则</p> |
 
-<a name="validatorFunction"></a>
+<a name="FormVerify.initFormItemData"></a>
 
-## validatorFunction ⇒ <code>string</code>
-自定义验证函数
+### FormVerify.initFormItemData(formObject)
+<p>初始化表单项数据</p>
 
-**Kind**: global typedef  
-**Returns**: <code>string</code> - 返回错误信息或者 null  
+**Kind**: static method of [<code>FormVerify</code>](#FormVerify)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| value | <code>any</code> | 需要验证的值 |
-
-<a name="ruleItem"></a>
-
-## ruleItem : <code>Object</code>
-验证规则对象
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| checkFields | <code>Array.&lt;string&gt;</code> | 需要验证的字段 |
-| rules | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | 验证规则 |
-
-<a name="checkCode"></a>
-
-## checkCode : <code>number</code>
-验证码
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| code_pass | <code>1</code> | 验证通过 |
-| code_notPass | <code>2</code> | 验证不通过 |
-| code_notMatch | <code>3</code> | 未匹配到验证规则 |
-
-<a name="formItemData"></a>
-
-## formItemData : <code>object</code>
-表单项数据
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [val] | <code>string</code> | 表单项值 |
-| [msg] | <code>string</code> | 表单项错误信息 |
-| [state] | <code>number</code> | 表单项状态 0 通过 1 通过 2 不通过 |
-| [showText] | <code>string</code> | 表单项显示文本,用于在某些 |
-| [label] | <code>string</code> | 表单项显示文本 |
-| [init] | <code>string</code> | 表单项初始值 |
-| [options] | <code>Array</code> | 表单项枚举值 |
-| [depend] | <code>string</code> | 依赖字段, 该项存在将使用依赖字段的option中的checkField字段进行匹配验证规则 |
-| [reCheckField] | <code>string</code> | 该表单项用于匹配规则的字段 |
-| [disables] | <code>Array</code> | 禁用项 |
+| formObject | <code>formObject</code> | <p>表单对象</p> |
 

jsdoc2md.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "includePattern": ".+\\.ts(doc|x)?$",
+    "excludePattern": ".+\\.(test|spec).ts"
+  },
+  "plugins": [
+    "plugins/markdown",
+    "node_modules/jsdoc-babel"
+  ],
+  "babel": {
+    "extensions": ["ts", "tsx"],
+    "ignore": ["**/*.(test|spec).ts"],
+    "babelrc": false,
+    "presets": [["@babel/preset-env", { "targets": { "node": true } }], "@babel/preset-typescript"]
+  }
+}

lib/fieldCheck.d.ts

@@ -94,7 +94,7 @@ declare class FieldCheck {
     ] | [checkCode];
     /**
      * 检查表单是否符合规则
-     * @param formObject 需要检验的表单项 字段:值
+     * @param {verifyForm} formObject 需要检验的表单项 字段:值
      * @param [isMustMatch] 是否强制要求匹配规则
      * @returns errMessage 错误码或错误信息
      */

lib/fieldCheck.js

@@ -234,7 +234,7 @@ class FieldCheck {
     }
     /**
      * 检查表单是否符合规则
-     * @param formObject 需要检验的表单项 字段:值
+     * @param {verifyForm} formObject 需要检验的表单项 字段:值
      * @param [isMustMatch] 是否强制要求匹配规则
      * @returns errMessage 错误码或错误信息
      */

lib/formVerify.d.ts

@@ -36,14 +36,14 @@ declare class FormVerify {
     static initFormItemData(formObject: formObject): void;
     /**
      * 检查表单项是否符合要求
-     * @param form 表单对象
+     * @param {formObject} form 表单对象
      * @param isMustMatch 是否必须全部匹配到验证规则
      * @returns {boolean}
      */
     checkForm(form: formObject, isMustMatch: boolean): boolean;
     /**
      * 验证当前的表单是否符合要求
-     * @param isMustMatch
+     * @param [isMustMatch] 是否必须全部匹配到验证规则
      */
     check(isMustMatch?: boolean): boolean;
 }

lib/formVerify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formVerify.d.ts","sourceRoot":"","sources":["../src/formVerify.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,cAAc,CAAC;AAStC;;;;;;GAMG;AACH,cAAM,UAAU;IACZ,QAAQ,EAAC,UAAU,GAAG,IAAI,CAAQ;IAElC,UAAU,EAAC,UAAU,CAAC;IAGtB,aAAa,EAAE,gBAAgB,CAE9B;IACD,MAAM,EAAE,gBAAgB,CAEtB;IAEF,OAAc,iBAAiB,EAAE,MAAM,CAAC;IACxC,OAAc,cAAc,EAAE,MAAM,CAAC;IACrC,OAAc,iBAAiB,EAAE,MAAM,CAAC;IAExC,iBAAiB,EAAE,MAAM,CAAK;IAC9B,cAAc,EAAE,MAAM,CAAK;IAC3B,iBAAiB,EAAE,MAAM,CAAK;gBAElB,UAAU,EAAC,UAAU,EAAE,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,CAAC,EAAC,gBAAgB;IAiBnF,MAAM,CAAC,QAAQ,CAAE,GAAG,EAAC,GAAG;IAIxB;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,OAAO;IA6G7C;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAG,UAAU,EAAE,UAAU;IAYhD;;;;;OAKG;IACI,SAAS,CAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO;IAkGlE;;;OAGG;IACI,KAAK,CAAE,WAAW,UAAQ,GAAI,OAAO;CAI/C;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"formVerify.d.ts","sourceRoot":"","sources":["../src/formVerify.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,cAAc,CAAC;AAStC;;;;;;GAMG;AACH,cAAM,UAAU;IACZ,QAAQ,EAAC,UAAU,GAAG,IAAI,CAAQ;IAElC,UAAU,EAAC,UAAU,CAAC;IAGtB,aAAa,EAAE,gBAAgB,CAE9B;IACD,MAAM,EAAE,gBAAgB,CAEtB;IAEF,OAAc,iBAAiB,EAAE,MAAM,CAAC;IACxC,OAAc,cAAc,EAAE,MAAM,CAAC;IACrC,OAAc,iBAAiB,EAAE,MAAM,CAAC;IAExC,iBAAiB,EAAE,MAAM,CAAK;IAC9B,cAAc,EAAE,MAAM,CAAK;IAC3B,iBAAiB,EAAE,MAAM,CAAK;gBAElB,UAAU,EAAC,UAAU,EAAE,UAAU,CAAC,EAAC,UAAU,EAAE,MAAM,CAAC,EAAC,gBAAgB;IAiBnF,MAAM,CAAC,QAAQ,CAAE,GAAG,EAAC,GAAG;IAIxB;;;;;;;;OAQG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,OAAO;IA6G7C;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAG,UAAU,EAAE,UAAU;IAYhD;;;;;OAKG;IACI,SAAS,CAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO;IAkGlE;;;OAGG;IACI,KAAK,CAAE,WAAW,GAAC,OAAe,GAAI,OAAO;CAIvD;AAED,eAAe,UAAU,CAAC"}

lib/formVerify.js

@@ -161,7 +161,7 @@ class FormVerify {
     }
     /**
      * 检查表单项是否符合要求
-     * @param form 表单对象
+     * @param {formObject} form 表单对象
      * @param isMustMatch 是否必须全部匹配到验证规则
      * @returns {boolean}
      */
@@ -256,7 +256,7 @@ class FormVerify {
     }
     /**
      * 验证当前的表单是否符合要求
-     * @param isMustMatch
+     * @param [isMustMatch] 是否必须全部匹配到验证规则
      */
     check(isMustMatch = false) {
         return this.checkForm(this.formData, isMustMatch);

package.json

@@ -10,7 +10,8 @@
     "utils"
   ],
   "scripts": {
-    "docs": "jsdoc2md src/*.js > api.md",
+    "docs": "jsdoc2md src/*.ts src/**/*.ts > api.md",
+    "build:doc": "jsdoc2md --files ./src/*.ts --configure ./jsdoc2md.json > ./api.md",
     "patch": "npm run build && npm version patch",
     "compile": "npx babel -d lib/ src/",
     "clean": "rimraf -rf lib/",
@@ -22,6 +23,9 @@
     "@babel/cli": "^7.23.0",
     "@babel/core": "^7.23.2",
     "@babel/preset-env": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
+    "jsdoc-babel": "^0.5.0",
+    "jsdoc-to-markdown": "^8.0.0",
     "rimraf": "^5.0.5",
     "rmdir": "^1.2.0",
     "typescript": "^5.2.2"

src/formVerify.ts

@@ -197,7 +197,7 @@ class FormVerify {
 
     /**
      * 检查表单项是否符合要求
-     * @param form 表单对象
+     * @param {formObject} form 表单对象
      * @param isMustMatch 是否必须全部匹配到验证规则
      * @returns {boolean}
      */