Skip to content

Commit 2aca4f2

Browse files
committed
Update infinite query example with page param changes (#4827)
1 parent 91f2e1b commit 2aca4f2

File tree

11 files changed

+20
-17
lines changed

11 files changed

+20
-17
lines changed

docs/rtk-query/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ This comparison table strives to be as accurate and as unbiased as possible. If
8282
| **Lagged queries** | yes | yes | no | ? |
8383
| **Auto garbage collection** | yes | yes | no | ? |
8484
| **Normalized caching** | no | no | yes | yes |
85-
| **Infinite scrolling** | TODO | yes | requires manual code | ? |
85+
| **Infinite scrolling** | yes | yes | requires manual code | ? |
8686
| **Prefetching** | yes | yes | yes | yes? |
8787
| **Retrying** | yes | yes | requires manual code | ? |
8888
| **Optimistic updates** | can update cache by hand | can update cache by hand | `optimisticResponse` | ? |

docs/rtk-query/usage/infinite-queries.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ const pokemonApi = createApi({
198198
endpoints: (build) => ({
199199
getPokemon: build.infiniteQuery<Pokemon[], string, number>({
200200
infiniteQueryOptions: {
201-
initialPageParam: 0,
201+
initialPageParam: 1,
202202
getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) =>
203203
lastPageParam + 1,
204204
},

examples/query/react/infinite-queries/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"type-check": "tsc --noEmit"
1616
},
1717
"dependencies": {
18-
"@reduxjs/toolkit": "https://pkg.csb.dev/reduxjs/redux-toolkit/commit/26bae549/@reduxjs/toolkit/_pkg.tgz",
18+
"@reduxjs/toolkit": "https://pkg.csb.dev/reduxjs/redux-toolkit/commit/e18b966e/@reduxjs/toolkit/_pkg.tgz",
1919
"react": "^18.2.0",
2020
"react-dom": "^18.2.0",
2121
"react-intersection-observer": "^9.13.1",

examples/query/react/infinite-queries/src/features/bidirectional-cursor-infinite-scroll/infiniteScrollApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export const apiWithInfiniteScroll = baseApi.injectEndpoints({
3131
QueryParamLimit,
3232
ProjectsInitialPageParam
3333
>({
34-
query: ({ before, after, around, limit }) => {
34+
query: ({ pageParam: { before, after, around, limit } }) => {
3535
const params = new URLSearchParams()
3636
params.append("limit", String(limit))
3737
if (after != null) {

examples/query/react/infinite-queries/src/features/infinite-scroll/infiniteScrollApi.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ type ProjectsPageCursor = {
1414
export const apiWithInfiniteScroll = baseApi.injectEndpoints({
1515
endpoints: build => ({
1616
getProjectsCursor: build.infiniteQuery<ProjectsPageCursor, string, number>({
17-
query: page => `https://example.com/api/projectsCursor?cursor=${page}`,
17+
query: ({ pageParam }) =>
18+
`https://example.com/api/projectsCursor?cursor=${pageParam}`,
1819
infiniteQueryOptions: {
1920
initialPageParam: 0,
2021
getPreviousPageParam: firstPage => firstPage.previousId,

examples/query/react/infinite-queries/src/features/limit-offset/infiniteScrollApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const apiWithInfiniteScroll = baseApi.injectEndpoints({
6161
}
6262
},
6363
},
64-
query: ({ offset, limit }) => {
64+
query: ({ pageParam: { offset, limit } }) => {
6565
return {
6666
url: `https://example.com/api/projectsLimitOffset?offset=${offset}&limit=${limit}`,
6767
method: "GET",

examples/query/react/infinite-queries/src/features/max-pages/infiniteScrollApi.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ export const apiWithInfiniteScrollMax = baseApi.injectEndpoints({
1818
string,
1919
number
2020
>({
21-
query: page => `https://example.com/api/projectsCursor?cursor=${page}`,
21+
query: ({ pageParam }) =>
22+
`https://example.com/api/projectsCursor?cursor=${pageParam}`,
2223
infiniteQueryOptions: {
2324
initialPageParam: 0,
2425
maxPages: 3,

examples/query/react/infinite-queries/src/features/pagination-infinite-scroll/infiniteScrollApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export const apiWithInfiniteScroll = baseApi.injectEndpoints({
6161
}
6262
},
6363
},
64-
query: ({ page, size }) => {
64+
query: ({ pageParam: { page, size } }) => {
6565
return {
6666
url: `https://example.com/api/projectsPaginated?page=${page}&size=${size}`,
6767
method: "GET",

examples/query/react/infinite-queries/src/features/pagination/paginationApi.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ type ProjectsPage = {
1313
export const apiWithPagination = baseApi.injectEndpoints({
1414
endpoints: build => ({
1515
getProjects: build.infiniteQuery<ProjectsPage, string, number>({
16-
query: page => `https://example.com/api/projects?page=${page}`,
16+
query: ({ pageParam }) =>
17+
`https://example.com/api/projects?page=${pageParam}`,
1718
infiniteQueryOptions: {
1819
initialPageParam: 0,
1920
getNextPageParam: (lastPage, pages, lastPageParam, allPageParams) => {

examples/query/react/infinite-queries/yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1743,9 +1743,9 @@ __metadata:
17431743
languageName: node
17441744
linkType: hard
17451745

1746-
"@reduxjs/toolkit@https://pkg.csb.dev/reduxjs/redux-toolkit/commit/26bae549/@reduxjs/toolkit/_pkg.tgz":
1746+
"@reduxjs/toolkit@https://pkg.csb.dev/reduxjs/redux-toolkit/commit/e18b966e/@reduxjs/toolkit/_pkg.tgz":
17471747
version: 2.5.0
1748-
resolution: "@reduxjs/toolkit@https://pkg.csb.dev/reduxjs/redux-toolkit/commit/26bae549/@reduxjs/toolkit/_pkg.tgz"
1748+
resolution: "@reduxjs/toolkit@https://pkg.csb.dev/reduxjs/redux-toolkit/commit/e18b966e/@reduxjs/toolkit/_pkg.tgz"
17491749
dependencies:
17501750
immer: "npm:^10.0.3"
17511751
redux: "npm:^5.0.1"
@@ -1759,7 +1759,7 @@ __metadata:
17591759
optional: true
17601760
react-redux:
17611761
optional: true
1762-
checksum: 10/c71e738c892ec549c0d242524b3789d306d7b6e320fa6219a2dd4a71adca68fbfccf3ce46a43631fe5076245c465259771e348f23b5ed3fb2e04e2d4e0aabb6b
1762+
checksum: 10/9bf78a12a14a745cfb2eef7e8509149652dba734b66012ac42449722c72bf3709b37e8dba1814635ab7baef04c286be003b4df7f7098f17e059ad3e449576f2f
17631763
languageName: node
17641764
linkType: hard
17651765

@@ -7433,7 +7433,7 @@ __metadata:
74337433
version: 0.0.0-use.local
74347434
resolution: "vite-template-redux@workspace:."
74357435
dependencies:
7436-
"@reduxjs/toolkit": "https://pkg.csb.dev/reduxjs/redux-toolkit/commit/26bae549/@reduxjs/toolkit/_pkg.tgz"
7436+
"@reduxjs/toolkit": "https://pkg.csb.dev/reduxjs/redux-toolkit/commit/e18b966e/@reduxjs/toolkit/_pkg.tgz"
74377437
"@testing-library/dom": "npm:^9.3.4"
74387438
"@testing-library/jest-dom": "npm:^6.2.0"
74397439
"@testing-library/react": "npm:^14.1.2"

0 commit comments

Comments
 (0)