Category | @Integrations |
---|---|
Export Size | 1.34 kB |
Package | @vueuse/integrations |
Last Changed | 2 weeks ago |
Wrapper for async-validator
.
npm i async-validator
import { useAsyncValidator } from '@vueuse/integrations/useAsyncValidator'
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 /** * 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/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>
© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/integrations/useAsyncValidator/