feat: export CreateMutationOptions & new typeUtil inferError

Author: liaoxuan

README-zh_CN.md

@@ -384,17 +384,20 @@ import { Middleware, MutationHook, QueryHook, getKey } from 'react-query-kit'
 const myMiddleware: Middleware<
   QueryHook<Response, Variables>
 > = useQueryNext => {
-  return options => {
+  return (options, queryClient) => {
     const { userId } = useAuth()
-    const client = useQueryClient()
+    const client = useQueryClient(queryClient)
     const variables = options.variables ?? { id: userId }
     const hasData = () => !!client.getQueryData(useUser.getKey(variables))
 
-    return useQueryNext({
-      ...options,
-      variables,
-      enabled: options.enabled ?? !hasData(),
-    })
+    return useQueryNext(
+      {
+        ...options,
+        variables,
+        enabled: options.enabled ?? !hasData(),
+      },
+      queryClient
+    )
   }
 }
 
@@ -482,13 +485,14 @@ exit  a
 您可以使用 `inferData` 或 `inferVariables` 提取任何自定义 hook 的 TypeScript 类型
 
 ```ts
-import { inferData, inferFnData, inferVariables, inferOptions } from 'react-query-kit'
+import { inferData, inferFnData, inferError, inferVariables, inferOptions } from 'react-query-kit'
 
 const useProjects = createInfiniteQuery<Response, Variables>(...)
 
 inferData<typeof useProjects> // InfiniteData<Response>
 inferFnData<typeof useProjects> // Response
 inferVariables<typeof useProjects> // Variables
+inferError<typeof useProjects> // Error
 inferOptions<typeof useProjects> // InfiniteQueryHookOptions<...>
 ```
 

README.md

@@ -16,7 +16,7 @@
   <a href="https://www.npmjs.com/package/react-query-kit"><img src="https://badgen.net/npm/v/react-query-kit" alt="Latest published version" target="\_parent"></a>
   <a href="https://unpkg.com/browse/react-query-kit@latest/build/umd/index.production.js" rel="nofollow"><img src="https://img.badgesize.io/https:/unpkg.com/react-query-kit@latest/build/umd/index.production.js?label=gzip%20size&compression=gzip" alt="gzip size"></a>
   <a href="https://github.com/liaoliao666/react-query-kit"><img src="https://badgen.net/npm/types/react-query-kit" alt="Types included" target="\_parent"></a>
-  <a href="https://www.npmjs.com/package/react-query-kit"><img src="https://badgen.net/npm/license/react-query-kit" alt="License" target="\_parent"></a>
+  <a href="https://github.com/liaoliao666/react-query-kit/blob/main/LICENSE"><img src="https://badgen.net/npm/license/react-query-kit" alt="License" target="\_parent"></a>
   <a href="https://www.npmjs.com/package/react-query-kit"><img src="https://badgen.net/npm/dt/react-query-kit" alt="Number of downloads" target="\_parent"></a>
   <a href="https://github.com/liaoliao666/react-query-kit"><img src="https://img.shields.io/github/stars/liaoliao666/react-query-kit.svg?style=social&amp;label=Star" alt="GitHub Stars" target="\_parent"></a>
 </p>
@@ -384,17 +384,20 @@ import { Middleware, MutationHook, QueryHook, getKey } from 'react-query-kit'
 const myMiddleware: Middleware<
   QueryHook<Response, Variables>
 > = useQueryNext => {
-  return options => {
+  return (options, queryClient) => {
     const { userId } = useAuth()
-    const client = useQueryClient()
+    const client = useQueryClient(queryClient)
     const variables = options.variables ?? { id: userId }
     const hasData = () => !!client.getQueryData(useUser.getKey(variables))
 
-    return useQueryNext({
-      ...options,
-      variables,
-      enabled: options.enabled ?? !hasData(),
-    })
+    return useQueryNext(
+      {
+        ...options,
+        variables,
+        enabled: options.enabled ?? !hasData(),
+      },
+      queryClient
+    )
   }
 }
 
@@ -482,13 +485,14 @@ exit  a
 You can extract the TypeScript type of any custom hook with `inferData` or `inferVariables`
 
 ```ts
-import { inferData, inferFnData, inferVariables, inferOptions } from 'react-query-kit'
+import { inferData, inferFnData, inferError, inferVariables, inferOptions } from 'react-query-kit'
 
-const useProjects = createInfiniteQuery<Response, Variables>(...)
+const useProjects = createInfiniteQuery<Response, Variables, Error>(...)
 
 inferData<typeof useProjects> // InfiniteData<Response>
 inferFnData<typeof useProjects> // Response
 inferVariables<typeof useProjects> // Variables
+inferError<typeof useProjects> // Error
 inferOptions<typeof useProjects> // InfiniteQueryHookOptions<...>
 ```
 

src/index.ts

@@ -21,11 +21,14 @@ export type {
   SuspenseInfiniteQueryHook,
   SuspenseInfiniteQueryHookOptions,
   SuspenseInfiniteQueryHookResult,
+  CreateMutationOptions,
   MutationHookOptions,
   MutationHook,
   inferVariables,
   inferData,
   inferFnData,
   inferOptions,
+  inferError,
+  inferCreateOptions,
   Middleware,
 } from './types'

src/types.ts

@@ -94,14 +94,14 @@ export type AdditionalCreateOptions<TFnData, TVariables, TPageParam = never> = {
   variables?: TVariables
 }
 
-type inferMiddleware<T extends (...args: any) => any> = (
+type inferMiddlewareHook<T extends (...args: any) => any> = (
   options: inferCreateOptions<T>,
   queryClient?: CompatibleWithV4<QueryClient, void>
 ) => ReturnType<T>
 
 export type Middleware<
   T extends (...args: any) => any = QueryHook<any, any, any>
-> = (hook: inferMiddleware<T>) => inferMiddleware<T>
+> = (hook: inferMiddlewareHook<T>) => inferMiddlewareHook<T>
 
 export type DeepPartial<T> = T extends object
   ? {
@@ -458,6 +458,18 @@ export type inferFnData<T> = T extends QueryHook<infer TData, any, any>
   ? TData
   : never
 
+export type inferError<T> = T extends QueryHook<any, any, infer TError>
+  ? TError
+  : T extends SuspenseQueryHook<any, any, infer TError>
+  ? TError
+  : T extends InfiniteQueryHook<any, any, infer TError>
+  ? TError
+  : T extends SuspenseInfiniteQueryHook<any, any, infer TError>
+  ? TError
+  : T extends MutationHook<any, any, infer TError>
+  ? TError
+  : never
+
 export type inferOptions<T> = T extends QueryHook<
   infer TFnData,
   infer TVariables,