Skip to content
On this page

useAsyncState

数据异步状态,在承诺就绪后触发更改

代码演示

基础用法

API

javascript
export interface UseAsyncStateOptions<D, F extends (...args: any[]) => Promise<D>> {
    shallow?: boolean,
    immediate?: boolean,
    onSuccess?: (data: D) => void,
    onError?: (E: unknown) => void,
    params?: Parameters<F> | (() => Parameters<F>)
}
const {state,loading,error,run} = function useAsyncState<D, F extends (...args: any[]) => Promise<D>>(
    func: F, 
    defaultValue: D,
    options?: UseAsyncStateOptions<D, F>
): UseAsyncStateReturn<D, F>
export interface UseAsyncStateOptions<D, F extends (...args: any[]) => Promise<D>> {
    shallow?: boolean,
    immediate?: boolean,
    onSuccess?: (data: D) => void,
    onError?: (E: unknown) => void,
    params?: Parameters<F> | (() => Parameters<F>)
}
const {state,loading,error,run} = function useAsyncState<D, F extends (...args: any[]) => Promise<D>>(
    func: F, 
    defaultValue: D,
    options?: UseAsyncStateOptions<D, F>
): UseAsyncStateReturn<D, F>

Params

参数说明类型默认值
func必填,要解析的promise/异步函数 (...args: any[]) => Promise<D>-
defaultValue必填,默认值D-
options可选,详见下面的 UseAsyncStateOptionsUseAsyncStateOptions-

Options

参数说明类型默认值
shallow可选,使用shallowRefboolean-
immediate可选,立即执行boolean-
onSuccess可选,成功回调(data: D) => void-
onError可选,失败回调 (E: unknown) => void-
params可选,可传递参数Parameters<F> () => Parameters<F>-