useAsyncValidator

分类

@Integrations

导出大小

1.13 kB

包

@vueuse/integrations

上次更改

8 个月前

async-validator 的封装。

演示

源代码在线演示 (beta)

可在 @vueuse/integrations 插件中使用。

安装

bash

npm i async-validator@^4

用法

TypeScript

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

export {}

类型声明

显示类型声明

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
: ShallowRef
<boolean>
  isFinished
: ShallowRef
<boolean>
  errors
: ComputedRef
<AsyncValidatorError
["errors"] | undefined>
  errorInfo
: ShallowRef
<AsyncValidatorError
 | null>
  errorFields
: ComputedRef
<AsyncValidatorError
["fields"] | undefined>
  execute
: () => Promise
<UseAsyncValidatorExecuteReturn>
}
export interface UseAsyncValidatorOptions {
  /**
   * @see https://github.com/yiminghe/async-validator#options
   */
  validateOption
?: ValidateOption

  /**
   * The validation will be triggered right away for the first time.
   * Only works when `manual` is not set to true.
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * If set to true, the validation will not be triggered automatically.
   */
  manual
?: boolean
}
/**
 * Wrapper for async-validator.
 *
 * @see https://vueuse.org.cn/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>