1---
2category: '@Integrations'
3---
4 
5# useAsyncValidator
6 
7Wrapper for [`async-validator`](https://github.com/yiminghe/async-validator).
8 
9## Install
10 
11```bash
12npm i async-validator@^4
13```
14 
15## Usage
16 
17```ts
18import { useAsyncValidator } from '@vueuse/integrations/useAsyncValidator'
19```
20 
21## Type Declarations
22 
23```ts
24export type AsyncValidatorError = Error & {
25  errors: ValidateError[]
26  fields: Record<string, ValidateError[]>
27}
28export interface UseAsyncValidatorExecuteReturn {
29  pass: boolean
30  errors: AsyncValidatorError["errors"] | undefined
31  errorInfo: AsyncValidatorError | null
32  errorFields: AsyncValidatorError["fields"] | undefined
33}
34export interface UseAsyncValidatorReturn {
35  pass: ShallowRef<boolean>
36  isFinished: ShallowRef<boolean>
37  errors: ComputedRef<AsyncValidatorError["errors"] | undefined>
38  errorInfo: ShallowRef<AsyncValidatorError | null>
39  errorFields: ComputedRef<AsyncValidatorError["fields"] | undefined>
40  execute: () => Promise<UseAsyncValidatorExecuteReturn>
41}
42export interface UseAsyncValidatorOptions {
43  /**
44   * @see https://github.com/yiminghe/async-validator#options
45   */
46  validateOption?: ValidateOption
47  /**
48   * The validation will be triggered right away for the first time.
49   * Only works when `manual` is not set to true.
50   *
51   * @default true
52   */
53  immediate?: boolean
54  /**
55   * If set to true, the validation will not be triggered automatically.
56   */
57  manual?: boolean
58}
59/**
60 * Wrapper for async-validator.
61 *
62 * @see https://vueuse.org/useAsyncValidator
63 * @see https://github.com/yiminghe/async-validator
64 */
65export declare function useAsyncValidator(
66  value: MaybeRefOrGetter<Record<string, any>>,
67  rules: MaybeRefOrGetter<Rules>,
68  options?: UseAsyncValidatorOptions,
69): UseAsyncValidatorReturn & PromiseLike<UseAsyncValidatorReturn>
70```
71