Skip to content

Commit 7094a61

Browse files
authored
docs: Update tanstack query docs on Infinite params
Update the docs to list out the regex params we use for matching infinite queries. This will make it easier for people debugging infinite queries to find the proper keywords.
1 parent 8e64bb3 commit 7094a61

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/openapi-ts/plugins/tanstack-query.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,15 @@ const { data, error } = useInfiniteQuery({
142142
});
143143
```
144144

145+
Infinite queries are recognized by having one of these keywords in the endpoint's parameters:
146+
147+
- after
148+
- before
149+
- cursor
150+
- offset
151+
- page
152+
- start
153+
145154
## Mutations
146155

147156
Mutations are generated from DELETE, PATCH, POST, and PUT endpoints. The generated functions follow the naming convention of SDK functions and append `Mutation`, e.g. `addPetMutation()`.

0 commit comments

Comments
 (0)