加载更多扩展 API
加载更多扩展。
const { ...ReturnValues } = useLoadMore<R, P, FR, LR>(Service, Options);
TS 泛型说明
LR
是 dataList
的类型 (注:该泛型受到 unknown[]
的约束)
用法参考: 加载更多扩展
Return Values
dataList
类型:
Ref<LR>
默认值:
[]
所有请求数据(数据取自 data[listkey])的合并数组
loadingMore
类型:
Ref<boolean>
默认值:
false
是否正在加载更多,用于记录
loadMore()
是否正在触发。如果想要判断Service
是否正在请求,请使用loading
New in 1.1.0
refreshing类型:
Ref<boolean>
默认值:
false
是否正在刷新,用于记录
refresh()
是否正在触发。
noMore
类型:
Ref<boolean>
默认值:
false
是否有更多数据,需要配合
isNoMore
使用
loadMore
类型:
() => void
默认值:
0
触发加载更多
reload
类型:
() => void
清空所有请求状态,以及请求结果(包括
dataList
),并重新触发请求
New in 1.1.0
refresh不支持
queriesLoadMore 模式下,不支持 并发请求
不支持
mutateLoadMore 模式下,不支持 数据更改
Service
请求函数
类型:
(returnData: ReturnDataType | undefined, ...params: P) => Promise<R>
| (returnData: ReturnDataType | undefined, ...params: P) => string
| (returnData: ReturnDataType | undefined, ...params: P) => ({ url: string; [key: string]: any; })
详情:
第一个参数的类型解释如下(首次请求时,第一个参数是
undefined
)type ReturnDataType = { data: R; // 上一次请求的结果 dataList: LR; // 当前存储的结果合并数组 };
不支持
字符串loadMore 模式下,不支持。
不支持
对象loadMore 模式下,不支持。
Options
listKey
- 类型:
string
- 默认值:
list
- 详情:
根据 data
对象的 path
路径获取值。与 lodash.get
相似,可以参考lodash 文档在新窗口打开。
const data = { a: [{ b: { c: 3 } }] };
const listKey = 'a[0].b.c';
// => 3
指定 data
中数据数组的路径
isNoMore
类型:
(data: R) => boolean
默认值:
false
详情:
判断是否还有更多数据
不支持
queryKeyLoadMore 模式下,不支持 并发请求