Skip to content

useAsyncValidator

类别
导出体积
1.13 kB
依赖包
@vueuse/integrations
上次更改
7 months ago

async-validator 的封装。

Demo

Available in the @vueuse/integrations add-on.

安装

bash
npm i async-validator@^4

用法

ts
import { 
useAsyncValidator
} from '@vueuse/integrations/useAsyncValidator'
js
export {}

类型声明

显示类型声明
ts
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
/** * 第一次将会立即触发验证。 * 当 `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>

源码

源码演示文档

贡献者

Anthony Fu
一纸忘忧
Anthony Fu
IlyaL
IlyaL
Jaw
Jelf
Vida Xie
Robin
James Garbutt
Doctorwu
류한경
Bakhtiyor Ruziev
Bakhtiyor Ruziev
Hawtim
vaakian X
Curt Grimes

更新日志

d5bcd - fix(integrations): use relative import in component.ts (#5025)
8c521 - feat(components)!: refactor components and make them consistent (#4912)
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)