Skip to content

feat(types): enable types in useQueries #2634

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

Merged
TkDodo merged 14 commits into from
Oct 23, 2021
Merged

feat(types): enable types in useQueries #2634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d8d5125
feat(types): enable types in useQueries
artysidorenko Sep 3, 2021
4cf69c8
feat: allow passing explicit type params to useQueries
artysidorenko Sep 11, 2021
e7a3f56
feat: infer useQueries argument/return without explicit type param
artysidorenko Sep 11, 2021
daeaff5
fix: make useQueries input readonly, and handle Array.map
artysidorenko Sep 11, 2021
aef0250
fix: useQueries - revert to regular array types when array is excessi…
artysidorenko Sep 11, 2021
42a5b49
fix: ts-ignore -> ts-expect-error
artysidorenko Oct 9, 2021
751b39a
feat: handle Array.map with consistent TQueryFnData / TData
artysidorenko Oct 9, 2021
27cf33d
test: confirm results inference works with complex handlers
artysidorenko Oct 9, 2021
71ec15f
feat: handle callback param typechecking with Arrap.map
artysidorenko Oct 9, 2021
833eab8
fix: clarify comments
artysidorenko Oct 9, 2021
bd75cb9
fix: prettier + further clean up comments
artysidorenko Oct 9, 2021
cef2332
test: clarify check against never
artysidorenko Oct 10, 2021
83e8887
feat: make backwards compatible for TS <4.1
artysidorenko Oct 17, 2021
4ec115c
docs: update with disclaimer on useQueries TS version
artysidorenko Oct 17, 2021
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/src/pages/typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ React Query is now written in **TypeScript** to make sure the library and your p
Things to keep in mind:

- Types currently require using TypeScript v3.8 or greater
- for [useQueries](./reference/useQueries.md), TypeScript v4.1 or greater is required to get the correct return type for each individual query (below v4.1 will mean the type of each returned `data` property is left as `unknown`)
- Changes to types in this repository are considered **non-breaking** and are usually released as **patch** semver changes (otherwise every type enhancement would be a major version!).
- It is **highly recommended that you lock your react-query package version to a specific patch release and upgrade with the expectation that types may be fixed or upgraded between any release**
- The non-type-related public API of React Query still follows semver very strictly.
Expand Down
3 changes: 3 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@
"optional": true
}
},
"typesVersions": {
"<4.1": { "types/*": ["types/ts3.8/*"] }
},
Comment on lines +78 to +80
Copy link
Contributor Author

@artysidorenko artysidorenko Oct 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know much about this feature tbh, but did a bunch of testing and it seems to work really well.

more info: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#version-selection-with-typesversions

"devDependencies": {
"@babel/cli": "^7.11.6",
"@babel/core": "^7.11.6",
Expand Down
Loading