Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(openapi-react-query) Update docs for useInfiniteQuery #2227

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −0
Open

docs(openapi-react-query) Update docs for useInfiniteQuery #2227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d87b728
chore(docs): Add missing link to useInfiniteQuery docs
Mar 25, 2025
80d648e
chore(docs): Add pageParamName to docs
Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/en.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export default defineConfig({
{ text: "useQuery", link: "/use-query" },
{ text: "useMutation", link: "/use-mutation" },
{ text: "useSuspenseQuery", link: "/use-suspense-query" },
{ text: "useInfiniteQuery", link: "/use-infinite-query" },
{ text: "queryOptions", link: "/query-options" },
],
},
Expand Down
3 changes: 3 additions & 0 deletions docs/openapi-react-query/use-infinite-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ const query = $api.useInfiniteQuery(
- Only required if the OpenApi schema requires parameters.
- The options `params` are used as key. See [Query Keys](https://tanstack.com/query/latest/docs/framework/react/guides/query-keys) for more information.
- `infiniteQueryOptions`
- `pageParamName`
- The name of the page parameter to use in the query. This will override any value provided in `options.query`.
- Default: `"cursor"`.
- The original `useInfiniteQuery` options.
- [See more information](https://tanstack.com/query/latest/docs/framework/react/reference/useInfiniteQuery)
- `queryClient`
Expand Down