Promise rejections and error thrown are shown in failureReason property instead of error property

[dnyaneshwar2023]

I am trying out react query for the first time and I found that something is behaving differently than as given in the documentation.

React Query Version: 5.0.0 (using with Next.js)

I modified my fetcher function little bit to test both Promise rejection and the throwing error scenario.

Scenario 1:

const result = useQuery({
    queryKey: ['todos', 1],
    queryFn: async () => {
      if (true) {
        throw new Error('Oh no!')
      }
      if (false) {
        return Promise.reject(new Error('Oh no!'))
      }
  
      return []
    },
  });

  console.log(result)

Output:

Scenario 2: (With promise rejection)

const result = useQuery({
    queryKey: ['todos', 1],
    queryFn: async () => {
      if (false) {
        throw new Error('Oh no!')
      }
      if (true) {
        return Promise.reject(new Error('Oh no! with promise rejection'))
      }
  
      return []
    },
  });

  console.log(result)

Output:

Correct me if I am missing something.

[TkDodo]

react-query does 3 retries per default. failureCount increases to 3 with the underlying failureReason before the query actually goes into error state. if you want instant error state, set retry: false

[dnyaneshwar2023]

Do you think it needs to be mentioned in the documentation? I am happy to contribute on it.

[TkDodo]

this is mentioned in multiple places I think

[dnyaneshwar2023]

https://tanstack.com/query/latest/docs/react/guides/query-functions?from=reactQueryV3&original=https%3A%2F%2Ftanstack.com%2Fquery%2Fv3%2Fdocs%2Fguides%2Fquery-functions#handling-and-throwing-errors

I think this part it's not much clear that error property will be updated after all retry attempts are done.
This was the point which I got this for the first time.

[TkDodo]

if you want, you can amend that information here: https://tanstack.com/query/latest/docs/react/guides/query-retries

[dnyaneshwar2023]

Sure, Thanks for your help!!