加载更多扩展 API
加载更多扩展。
const { ...ReturnValues } = useLoadMore<R>(Service, Options);
TS 类型说明
type DataType = { list: any[]; [key: string]: any };
用法参考: 加载更多扩展
Service
请求函数
类型:
(data?: DataType) => Promise<DataType>详情:
Service返回的数据必须包含list数组,类型为{ list: any[], ...other }Service的入参为整合后的最新的data
Return Values
data
类型:
shallowRef<DataType>默认值:
[]Service返回的数据,必须包含list数组,类型为{ list: any[], ...other },其中的list属性为聚合后数据
dataList
类型:
Ref<DataType['list']>默认值:
[]data中的list数组
error
类型:
shallowRef<Error>默认值:
[]Service返回的错误
loading
类型:
Ref<boolean>默认值:
false是否正在进行请求
loadingMore
类型:
Ref<boolean>默认值:
false是否正在加载更多
noMore
类型:
Ref<boolean>默认值:
false是否有更多数据,需要配合
isNoMore使用
loadMore
类型:
() => void默认值:
0触发加载更多。会自动捕获异常,通过
options.onError处理
loadMoreAsync
类型:
() => Promise<DataType>与
loadMore用法一致,但返回的是Promise,需要自行处理异常。
refresh
类型:
() => void重新加载第一页数据。会自动捕获异常,通过
options.onError处理
refreshAsync
类型:
() => Promise<DataType>与
refresh用法一致,但返回的是Promise,需要自行处理异常。
mutate
类型:
(arg: (oldData: DataType) => DataType) => void | (newData: DataType) => void直接修改
data的结果
cancel
类型:
() => void取消请求
Options
isNoMore
类型:
(data?: DataType) => boolean详情:
判断是否还有更多数据。
manual
类型:
boolean默认值:
false详情:
当设置为
true时,你需要手动触发loadMore或者loadMoreAsync才会发起请求。
ready 响应式
类型:
Ref<boolean>默认值:
false详情:
同
useRequest的 ready
refreshDeps
类型:
WatchSource<any>[]默认值:
[]详情:
同
useRequest的 refreshDeps
refreshDepsAction
类型:
() => void详情:
同
useRequest的 refreshDepsAction
debounceInterval 响应式
类型:
number | Ref<number>默认值:
undefined详情:
同
useRequest的 debounceInterval
debounceOptions 响应式
类型:
DebounceOptions | Reactive<DebounceOptions>详情:
同
useRequest的 debounceOptions
throttleInterval 响应式
类型:
number | Ref<number>默认值:
undefined详情:
同
useRequest的 throttleInterval
throttleOptions 响应式
类型:
ThrottleOptions | Reactive<ThrottleOptions>详情:
同
useRequest的 throttleOptions
errorRetryCount 响应式
类型:
number | Ref<number>默认值:
0详情:
同
useRequest的 errorRetryCount
errorRetryInterval 响应式
类型:
number | Ref<number>默认值:
0详情:
同
useRequest的 errorRetryInterval
onBefore
类型:
() => void详情:
Service执行前触发。
onAfter
类型:
() => void详情:
Service执行完成时触发。
onSuccess
类型:
(data: DataType) => void详情:
当
Serviceresolve时触发,参数为data。
onError
类型:
(error: Error) => void详情:
当
Servicereject时触发,参数为error。
