Query Functions

A query function can be literally any function that returns a promise. The promise that is returned should either resolve the data or throw an error.

All of the following are valid query function configurations:

1 useQuery(['todos'], fetchAllTodos)
2 useQuery(['todos', todoId], () => fetchTodoById(todoId))
3 useQuery(['todos', todoId], async () => {
4   const data = await fetchTodoById(todoId)
5   return data
6 })
7 useQuery(['todos', todoId], ({ queryKey }) => fetchTodoById(queryKey[1]))

Handling and Throwing Errors

For React Query to determine a query has errored, the query function must throw. Any error that is thrown in the query function will be persisted on the error state of the query.

1 const { error } = useQuery(['todos', todoId], async () => {
2   if (somethingGoesWrong) {
3     throw new Error('Oh no!')
4   }
5 
6   return data
7 })

Usage with fetch and other clients that do not throw by default

While most utilities like axios or graphql-request automatically throw errors for unsuccessful HTTP calls, some utilities like fetch do not throw errors by default. If that's the case, you'll need to throw them on your own. Here is a simple way to do that with the popular fetch API:

1 useQuery(['todos', todoId], async () => {
2   const response = await fetch('/todos/' + todoId)
3   if (!response.ok) {
4     throw new Error('Network response was not ok')
5   }
6   return response.json()
7 })

Query Function Variables

Query keys are not just for uniquely identifying the data you are fetching, but are also conveniently passed into your query function as part of the QueryFunctionContext. While not always necessary, this makes it possible to extract your query functions if needed:

1 function Todos({ status, page }) {
2   const result = useQuery(['todos', { status, page }], fetchTodoList)
3 }
4 
5 // Access the key, status and page variables in your query function!
6 function fetchTodoList({ queryKey }) {
7   const [_key, { status, page }] = queryKey
8   return new Promise()
9 }

QueryFunctionContext

The QueryFunctionContext is the object passed to each query function. It consists of:

• queryKey: QueryKey: Query Keys
• pageParam: unknown | undefined
  • only for Infinite Queries
  • the page parameter used to fetch the current page
• signal?: AbortSignal
  • AbortSignal instance provided by react-query
  • Can be used for Query Cancellation
• meta?: Record<string, unknown>
  • an optional field you can fill with additional information about your query

Using a Query Object instead of parameters

Anywhere the [queryKey, queryFn, config] signature is supported throughout React Query's API, you can also use an object to express the same configuration:

1 import { useQuery } from 'react-query'
2 
3 useQuery({
4   queryKey: ['todo', 7],
5   queryFn: fetchTodo,
6   ...config,
7 })