useAsyncValidator

类别

@Integrations

导出体积

1.34 kB

依赖包

@vueuse/integrations

上次更改

3 minutes ago

对 async-validator 的封装。

Demo

source

Available in the @vueuse/integrations add-on.

安装

bash

npm i async-validator@^4

用法

TypeScript

import { useAsyncValidator } from '@vueuse/integrations/useAsyncValidator'

export {}

类型声明

显示类型声明

typescript

export type AsyncValidatorError = Error & {
  errors: ValidateError[]
  fields: Record<string, ValidateError[]>
}
export interface UseAsyncValidatorExecuteReturn {
  pass: boolean
  errors: AsyncValidatorError["errors"] | undefined
  errorInfo: AsyncValidatorError | null
  errorFields: AsyncValidatorError["fields"] | undefined
}
export interface UseAsyncValidatorReturn {
  pass: Ref<boolean>
  isFinished: Ref<boolean>
  errors: Ref<AsyncValidatorError["errors"] | undefined>
  errorInfo: Ref<AsyncValidatorError | null>
  errorFields: Ref<AsyncValidatorError["fields"] | undefined>
  execute: () => Promise<UseAsyncValidatorExecuteReturn>
}
export interface UseAsyncValidatorOptions {
  /**
   * @see https://github.com/yiminghe/async-validator#options
   */
  validateOption?: ValidateOption
  /**
   * 第一次将会立即触发验证。
   * 当 `manual` 设置为 true 时才有效。
   *
   * @default true
   */
  immediate?: boolean
  /**
   * 如果设置为 true，验证将不会自动触发。
   */
  manual?: boolean
}
/**
 * async-validator 的包装器。
 *
 * @see https://vueuse.org/useAsyncValidator
 * @see https://github.com/yiminghe/async-validator
 */
export declare function useAsyncValidator(
  value: MaybeRefOrGetter<Record<string, any>>,
  rules: MaybeRefOrGetter<Rules>,
  options?: UseAsyncValidatorOptions,
): UseAsyncValidatorReturn & PromiseLike<UseAsyncValidatorReturn>