2.0.8

Changes

feat: automatically infer TQueryData by TQueryKey
feat: include TError in the return type of getOptions
feat: using useSuspenseQuery instead of useQuery in v5

Benefit from ReactQuery v5

Automatically infer TQueryData from TQueryKey

const useTest = createQuery({
  primaryKey: 'test',
  queryFn: () => `string`,
})

const data = queryClient.getQueryData(useTest.getKey())
//     ^? const data: string | undefined

Register a global error

declare module '@tanstack/react-query' {
  interface Register {
    defaultError: AxiosError
  }
}

const useTest = createQuery({
  primaryKey: 'test',
  queryFn: () => `string`,
})

const { error } = useTest()
//      ^? const error: AxiosError | null

2.0.7

feat: compatible error
feat: compatible DefinedUseInfiniteQueryResult
feat: adjust throwOnError logic in suspense mode

2.0.6

fix: type TData with initialData is undefined
feat: remove automatically inspect primary key

2.0.6-beta.0

Changes

feat: replace suspense query with option suspense
docs: remove suspense query

BREAKING CHANGES

Removed createSuspenseQuery and createSuspenseInfiniteQuery and use option suspense instead.

Before:

const useUser = createSuspenseQuery<Response>({
  // ...
})

After

const useUser = createQuery<Response>({
  // ...
})

const { data, error } = useUser({ suspense: true }) // data: Response, error: null

See discussion #38

2.0.5

feat: type TVariables defaults to void

2.0.4

feat: new expose method getOptions
feat: automatically inspect the duplicated primaryKey
fix: getKey does not return correct type

2.0.3

feat: export all of types
fix: remove type "DefaultError" imported from React Query

2.0.2

fix: correct the peer dependencies

2.0.1

1. feat: export type CreateMutationOptions
2. feat: add new typeUtil inferError

2.0.0

Changes

1. feat: optimize middleware type
2. feat: remove all built-in APIs

BREAKING CHANGES

All built-in APIs(such as useDefaultOptions, functional enabled and setData) are no longer support. Please use middleware instead.

Before:

const useUser = createQuery<Response, Variables>({
  // ...
  enabled: (data) => !data
})

After 2.0.0

const disabledIfHasData: Middleware<QueryHook<Response, Variables>> = useQueryNext => {
  return options => {
    const client = useQueryClient()
    const hasData = () =>
      !!client.getQueryData(useUser.getKey(options.variables))

    return useQueryNext({
      ...options,
      enabled: options.enabled ?? !hasData(),
    })
  }
}

const useUser = createQuery<Response, Variables>({
  // ...
  use: [disabledIfHasData],
})