VueUseuseAsyncValidator
Wrapper for async-validator.
Demo
Available in the @vueuse/integrations add-on.Install
bash
npm i async-validator
npm i async-validator
Usage
ts
import { useAsyncValidator } from '@vueuse/integrations/useAsyncValidator'
import { useAsyncValidator } from '@vueuse/integrations/useAsyncValidator'
Type Declarations
typescript
export declare type AsyncValidatorError = Error & {
errors: ValidateError[]
fields: Record<string, ValidateError[]>
}
export interface UseAsyncValidatorReturn {
pass: Ref<boolean>
errorInfo: Ref<AsyncValidatorError | null>
isFinished: Ref<boolean>
errors: Ref<AsyncValidatorError["errors"] | undefined>
errorFields: Ref<AsyncValidatorError["fields"] | undefined>
}
export interface UseAsyncValidatorOptions {
/**
* @see https://github.com/yiminghe/async-validator#options
*/
validateOption?: ValidateOption
}
/**
* Wrapper for async-validator.
*
* @see https://vueuse.org/useAsyncValidator
* @see https://github.com/yiminghe/async-validator
*/
export declare function useAsyncValidator(
value: MaybeComputedRef<Record<string, any>>,
rules: MaybeComputedRef<Rules>,
options?: UseAsyncValidatorOptions
): UseAsyncValidatorReturn & PromiseLike<UseAsyncValidatorReturn>
export declare type AsyncValidatorError = Error & {
errors: ValidateError[]
fields: Record<string, ValidateError[]>
}
export interface UseAsyncValidatorReturn {
pass: Ref<boolean>
errorInfo: Ref<AsyncValidatorError | null>
isFinished: Ref<boolean>
errors: Ref<AsyncValidatorError["errors"] | undefined>
errorFields: Ref<AsyncValidatorError["fields"] | undefined>
}
export interface UseAsyncValidatorOptions {
/**
* @see https://github.com/yiminghe/async-validator#options
*/
validateOption?: ValidateOption
}
/**
* Wrapper for async-validator.
*
* @see https://vueuse.org/useAsyncValidator
* @see https://github.com/yiminghe/async-validator
*/
export declare function useAsyncValidator(
value: MaybeComputedRef<Record<string, any>>,
rules: MaybeComputedRef<Rules>,
options?: UseAsyncValidatorOptions
): UseAsyncValidatorReturn & PromiseLike<UseAsyncValidatorReturn>
Source
Contributors
Anthony Fu
Jelf
Curt Grimes