types(Field): expose sub-types of FieldRule (#9843)

* types(Field): expose sub-types of FieldRule

* types: update

packages/vant/src/checkbox/types.ts

@@ -7,13 +7,9 @@ export type CheckboxLabelPosition = CheckerLabelPosition;
 
 export type CheckboxExpose = {
   toggle: (newValue?: boolean) => void;
-  /**
+  /** @private */
-   * @private
-   */
   props: CheckboxProps;
-  /**
+  /** @private */
-   * @private
-   */
   checked: ComputedRef<boolean>;
 };
 

packages/vant/src/field/README.md

@@ -318,8 +318,11 @@ import type {
   FieldProps,
   FieldInstance,
   FieldTextAlign,
+  FieldRuleMessage,
   FieldClearTrigger,
   FieldFormatTrigger,
+  FieldRuleValidator,
+  FiledRuleFormatter,
   FieldValidateError,
   FieldAutosizeConfig,
   FieldValidateTrigger,

packages/vant/src/field/README.zh-CN.md

@@ -337,8 +337,11 @@ import type {
   FieldProps,
   FieldInstance,
   FieldTextAlign,
+  FieldRuleMessage,
   FieldClearTrigger,
   FieldFormatTrigger,
+  FieldRuleValidator,
+  FiledRuleFormatter,
   FieldValidateError,
   FieldAutosizeConfig,
   FieldValidateTrigger,

packages/vant/src/field/index.ts

@@ -9,8 +9,11 @@ export type {
   FieldRule,
   FieldInstance,
   FieldTextAlign,
+  FieldRuleMessage,
   FieldClearTrigger,
   FieldFormatTrigger,
+  FieldRuleValidator,
+  FiledRuleFormatter,
   FieldValidateError,
   FieldAutosizeConfig,
   FieldValidateTrigger,

packages/vant/src/field/types.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-use-before-define */
 import type { ComputedRef, ComponentPublicInstance } from 'vue';
 import type { FieldProps } from './Field';
 
@@ -28,16 +29,24 @@ export type FieldValidateError = {
   message: string;
 };
 
-export type FieldRule = {
+export type FieldRuleMessage =
-  pattern?: RegExp;
+  | string
-  trigger?: FieldValidateTrigger;
+  | ((value: any, rule: FieldRule) => string);
-  message?: string | ((value: any, rule: FieldRule) => string);
+
-  required?: boolean;
+export type FieldRuleValidator = (
-  validator?: (
   value: any,
   rule: FieldRule
 ) => boolean | string | Promise<boolean | string>;
-  formatter?: (value: any, rule: FieldRule) => string;
+
+export type FiledRuleFormatter = (value: any, rule: FieldRule) => string;
+
+export type FieldRule = {
+  pattern?: RegExp;
+  trigger?: FieldValidateTrigger;
+  message?: FieldRuleMessage;
+  required?: boolean;
+  validator?: FieldRuleValidator;
+  formatter?: FiledRuleFormatter;
 };
 
 // Shared props of Field and Form
@@ -57,9 +66,7 @@ export type FieldExpose = {
     rules?: FieldRule[] | undefined
   ) => Promise<void | FieldValidateError>;
   resetValidation: () => void;
-  /**
+  /** @private */
-   * @private
-   */
   formValue: ComputedRef<unknown>;
 };
 

packages/vant/src/swipe/types.ts

@@ -19,9 +19,7 @@ export type SwipeExpose = {
   next: () => void;
   resize: () => void;
   swipeTo: (index: number, options?: SwipeToOptions) => void;
-  /**
+  /** @private */
-   * @private
-   */
   state: SwipeState;
 };