formVerify.d.ts 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. import FieldCheck from "./fieldCheck";
  2. /**
  3. * @class FormItem 表单验证类
  4. * @description 表单项
  5. * @param {formObject} formObject 表单项数据
  6. * @param {FieldCheck} [fieldCheck] 字段验证对象
  7. * @param {object} [option] 配置项
  8. */
  9. declare class FormVerify {
  10. formData: formObject | null;
  11. fieldCheck: FieldCheck;
  12. defaultOption: FormVerifyOption;
  13. option: FormVerifyOption;
  14. static formState_default: number;
  15. static formState_pass: number;
  16. static formState_notPass: number;
  17. formState_default: number;
  18. formState_pass: number;
  19. formState_notPass: number;
  20. constructor(formObject: formObject, fieldCheck?: FieldCheck, option?: FormVerifyOption);
  21. static isObject(obj: any): boolean;
  22. /**
  23. * 检查表单项是否符合要求
  24. * @param object 表单项数据
  25. * @param field 字段名
  26. * @param formItemData 表单项数据
  27. * @param fieldCheck 字段验证对象
  28. * @param isMustMatchRule 表单字段是否必须匹配到验证规则
  29. * @returns errMsg 错误信息
  30. */
  31. static buildFormItem(object: formObject, field: string, formItemData: formItemData, fieldCheck: FieldCheck, isMustMatchRule: boolean): string;
  32. /**
  33. * 初始化表单项数据
  34. * @param { formObject } formObject 表单对象
  35. */
  36. static initFormItemData(formObject: formObject): void;
  37. onLog: (msg: string) => void;
  38. /**
  39. * 检查表单项是否符合要求
  40. * @param {formObject} form 表单对象
  41. * @param isMustMatch 是否必须全部匹配到验证规则
  42. * @returns {boolean}
  43. */
  44. checkForm(form: formObject, isMustMatch: boolean): boolean;
  45. /**
  46. * 验证当前的表单是否符合要求
  47. * @param [isMustMatch] 是否必须全部匹配到验证规则
  48. */
  49. check(isMustMatch?: boolean): boolean;
  50. /**
  51. * 检测特定表单项的内容是否符合规则
  52. * @param field 字段名
  53. * @param isMustMatch 是否必须匹配到验证规则 默认 true
  54. */
  55. checkItem(field: string, isMustMatch?: boolean): boolean;
  56. /**
  57. * 使用该表单绑定的验证器进行验证字段与值是否符合规则
  58. * @param field 要验证的字段
  59. * @param value 要验证的值
  60. * @param isMustMatch
  61. */
  62. verifyKnV(field: string, value: any, isMustMatch?: boolean): errMessage;
  63. /**
  64. * 获取表单keyValue数据对
  65. * @returns {verifyForm} key:value
  66. */
  67. getFormData(): verifyForm;
  68. }
  69. export default FormVerify;
  70. //# sourceMappingURL=formVerify.d.ts.map