Skip to content

docs(typescript): add note for custom hooks types #1185

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
merged 1 commit into from
Oct 20, 2020
Merged

docs(typescript): add note for custom hooks types #1185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/src/pages/docs/typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,14 @@ npm install react-query --save

- The query results are no longer discriminated unions, which means you have to check the actual `data` and `error` properties.
- Requires TypeScript v3.8 or greater

## Defining Custom Hooks

When defining a custom hook you need to specify the result and error types, for example:

export function useGroups() {
return useQuery<Group[], Error>(
'list-groups',
() => fetch(`/api/groups`).then(res => res.json())
)
}