Skip to content

Commit 921f170

Browse files
committed
Add more information about pagination with useFind
1 parent 2f8b062 commit 921f170

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/composition-api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ And here's a look at each individual property:
9393
- When provided alone (without the optional `fetchParams`), this same query is used for both the local data store and the API requests.
9494
- Explicitly returning `null` will prevent an API request from being made.
9595
- You can use `params.qid` to dynamically specify the query identifier for any API request. The `qid` is used for tracking pagination data and enabling the fall-through cache across multiple queries.
96-
- Set `params.paginate` to `true` to turn off realtime updates for the results and defer pagination to the API server.
96+
- Set `params.paginate` to `true` to turn off realtime updates for the results and defer pagination to the API server. Pagination works the same as for the [makeFindMixin pagination](./mixins.html#pagination-with-fall-through-cacheing).
9797
- Set `params.debounce` to an integer and the API requests will automatically be debounced by that many milliseconds. For example, setting `debounce: 1000` will assure that the API request will be made at most every 1 second.
9898
- `fetchParams` This is a separate set of params that, when provided, will become the params sent to the API server. The `params` will then only be used to query data from the local data store.
9999
- Explicitly returning `null` will prevent an API request from being made.
@@ -273,7 +273,11 @@ interface UseGetData {
273273
}
274274
```
275275
276-
## Pattens: `useFind` with `useGet`
276+
## Patterns & Examples
277+
278+
### Server-Side Pagination
279+
280+
Similar to what was introduced with the `makeFindMixin` in Feathers-Vuex 2.0, the `useFind` API supports server-side pagination. It is enabled by passing `paginate: true` in the `params` (or the `fetchParams` if you're using separate queries). For an overview of how it works, refer to the [makeFindMixin pagination docs](./mixins.html#pagination-with-fall-through-cacheing).
277281
278282
### Simultaneous Queries
279283

0 commit comments

Comments
 (0)