feat: new expose method getOptions

Author: liaoxuan

README-zh_CN.md

@@ -133,8 +133,8 @@ const data = await queryClient.fetchQuery(
 // useQueries 例子
 const queries = useQueries({
   queries: [
-    usePost.getFetchOptions(variables)，
-    useUser.getFetchOptions(),
+    usePost.getOptions(variables)，
+    useUser.getOptions(),
   ],
 })
 
@@ -159,6 +159,7 @@ Expose Methods
 - `getKey: (variables: TVariables) => [primaryKey, variables]`
 - `queryFn: QueryFunction<TFnData, [primaryKey, TVariables]>`
 - `queryKeyHashFn: (queryKey: [primaryKey, TVariables]) => string`
+- `getOptions: (variables: TVariables) => UseInfiniteQueryOptions`
 - `getFetchOptions: (variables: TVariables) => ({ queryKey, queryFn, queryKeyHashFn })`
 
 ## createInfiniteQuery
@@ -255,6 +256,7 @@ Expose Methods
 - `getKey: (variables: TVariables) => [primaryKey, variables]`
 - `queryFn: QueryFunction<TFnData, [primaryKey, TVariables]>`
 - `queryKeyHashFn: (queryKey: [primaryKey, TVariables]) => string`
+- `getOptions: (variables: TVariables) => UseInfiniteQueryOptions`
 - `getFetchOptions: (variables: TVariables) => ({ queryKey, queryFn, queryKeyHashFn, getNextPageParam, getPreviousPageParam, initialPageParam })`
 
 ## createSuspenseQuery

README.md

@@ -135,8 +135,8 @@ const data = await queryClient.fetchQuery(usePost.getFetchOptions(variables))
 // useQueries example
 const queries = useQueries({
   queries: [
-   usePost.getFetchOptions(variables),
-   useUser.getFetchOptions(),
+   usePost.getOptions(variables),
+   useUser.getOptions(),
   ],
 })
 
@@ -161,6 +161,7 @@ Expose Methods
 - `getKey: (variables: TVariables) => [primaryKey, variables]`
 - `queryFn: QueryFunction<TFnData, [primaryKey, TVariables]>`
 - `queryKeyHashFn: (queryKey: [primaryKey, TVariables]) => string`
+- `getOptions: (variables: TVariables) => UseQueryOptions`
 - `getFetchOptions: (variables: TVariables) => ({ queryKey, queryFn, queryKeyHashFn })`
 
 ## createInfiniteQuery
@@ -257,6 +258,7 @@ Expose Methods
 - `getKey: (variables: TVariables) => [primaryKey, variables]`
 - `queryFn: QueryFunction<TFnData, [primaryKey, TVariables]>`
 - `queryKeyHashFn: (queryKey: [primaryKey, TVariables]) => string`
+- `getOptions: (variables: TVariables) => UseInfiniteQueryOptions`
 - `getFetchOptions: (variables: TVariables) => ({ queryKey, queryFn, queryKeyHashFn, getNextPageParam, getPreviousPageParam, initialPageParam })`
 
 ## createSuspenseQuery

src/createBaseQuery.ts

@@ -39,14 +39,14 @@ export const createBaseQuery = (
 
   if (process.env.NODE_ENV !== 'production') {
     if (existedPrimaryKeys.has(primaryKey)) {
-      throw new Error(`[Bug] Duplicated primaryKey: ${primaryKey}`)
+      console.error(`[Bug] Duplicated primaryKey: ${primaryKey}`)
     } else {
       existedPrimaryKeys.add(primaryKey)
     }
 
     // @ts-ignore
     if (defaultOptions.useDefaultOptions) {
-      throw new Error(
+      console.error(
         '[Bug] useDefaultOptions is not supported, please use middleware instead.'
       )
     }
@@ -56,6 +56,13 @@ export const createBaseQuery = (
 
   const getKey = (variables?: any) => getQueryKey(primaryKey, variables)
 
+  const getOptions = (variables: any) => {
+    return {
+      ...defaultOptions,
+      queryKey: getKey(variables),
+    }
+  }
+
   const getFetchOptions = (variables: any) => {
     return {
       queryKey: getKey(variables),
@@ -86,6 +93,7 @@ export const createBaseQuery = (
     getKey,
     queryFn,
     queryKeyHashFn,
+    getOptions,
     getFetchOptions,
   })
 }

src/types.ts

@@ -139,6 +139,9 @@ export type ExposeMethods<TFnData, TVariables, TPageParam = never> = {
         >
         queryKeyHashFn?: QueryKeyHashFunction<inferQueryKey<TVariables>>
       } & CompatibleInfiniteQueryPageParamsOptions<TFnData, TPageParam>
+  // TODO This seems pretty hacky for select & useQueries.
+  // But not work to infer TError, Hope to fix it.
+  getOptions: ExposeMethods<TFnData, TVariables, TPageParam>['getFetchOptions']
 }
 
 // query hook

tests/createInfiniteQuery.test.tsx

@@ -26,6 +26,13 @@ describe('createInfiniteQuery', () => {
     expect(useGeneratedQuery.getPrimaryKey()).toBe(primaryKey)
     expect(useGeneratedQuery.getKey()).toEqual([primaryKey])
     expect(useGeneratedQuery.getKey(variables)).toEqual([primaryKey, variables])
+    expect(useGeneratedQuery.getOptions(variables)).toEqual({
+      primaryKey,
+      queryKey: [primaryKey, variables],
+      queryFn,
+      initialPageParam,
+      getNextPageParam,
+    })
     expect(useGeneratedQuery.getFetchOptions(variables)).toEqual({
       queryKey: [primaryKey, variables],
       queryFn,

tests/createQuery.test.tsx

@@ -22,6 +22,11 @@ describe('createQuery', () => {
     expect(useGeneratedQuery.getPrimaryKey()).toBe(primaryKey)
     expect(useGeneratedQuery.getKey()).toEqual([primaryKey])
     expect(useGeneratedQuery.getKey(variables)).toEqual([primaryKey, variables])
+    expect(useGeneratedQuery.getOptions(variables)).toEqual({
+      primaryKey,
+      queryKey: [primaryKey, variables],
+      queryFn,
+    })
     expect(useGeneratedQuery.getFetchOptions(variables)).toEqual({
       queryKey: [primaryKey, variables],
       queryFn,