加载更多扩展 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
详情:
当
Service
resolve
时触发,参数为data
。
onError
类型:
(error: Error) => void
详情:
当
Service
reject
时触发,参数为error
。