Tweak types (#1640)

* test: add test for #1586 Author: YixuanXu <[email protected]> Date: Tue Nov 16 19:57:15 2021 +0800 * fix: allow user to use generics Author: YixuanXu <[email protected]> Date: Tue Nov 16 19:58:38 2021 +0800 * chore: remove comments * fix: allow fallback to origin fetcher * chore: remove comment * chore: rename to barefetcher * add test Co-authored-by: Shu Ding <[email protected]>
vercel · Nov 23, 2021 · 34777e5 · 34777e5
1 parent 4c60fcd
commit 34777e5
Show file tree

Hide file tree

Showing 4 changed files with 194 additions and 29 deletions.
diff --git a/infinite/types.ts b/infinite/types.ts
@@ -1,4 +1,4 @@
-import { SWRConfiguration, SWRResponse, Arguments } from 'swr'
+import { SWRConfiguration, SWRResponse, Arguments, BareFetcher } from 'swr'
 
 type FetcherResponse<Data = unknown> = Data | Promise<Data>
 
@@ -9,6 +9,8 @@ export type InfiniteFetcher<
   ? ((...args: [...K]) => FetcherResponse<Data>)
   : Args extends null
   ? never
+  : Args extends false
+  ? never
   : Args extends (infer T)
   ? (...args: [T]) => FetcherResponse<Data>
   : never
@@ -57,4 +59,20 @@ export interface SWRInfiniteHook {
       | SWRInfiniteConfiguration<Data, Error, SWRInfiniteArguments>
       | undefined
   ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any>(
+    getKey: InfiniteKeyLoader<Arguments>
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any>(
+    getKey: InfiniteKeyLoader<Arguments>,
+    fetcher: BareFetcher<Data> | null
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any>(
+    getKey: InfiniteKeyLoader<Arguments>,
+    config: SWRInfiniteConfiguration<Data, Error, Arguments> | undefined
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any>(
+    getKey: InfiniteKeyLoader<Arguments>,
+    fetcher: BareFetcher<Data> | null,
+    config: SWRInfiniteConfiguration<Data, Error, Arguments> | undefined
+  ): SWRInfiniteResponse<Data, Error>
 }
diff --git a/src/index.ts b/src/index.ts
@@ -18,6 +18,7 @@ export {
   SWRResponse,
   Cache,
   SWRHook,
+  BareFetcher,
   Fetcher,
   MutatorCallback,
   Middleware,

diff --git a/src/types.ts b/src/types.ts
@@ -1,34 +1,23 @@
 import * as revalidateEvents from './constants/revalidate-events'
 
 export type FetcherResponse<Data = unknown> = Data | Promise<Data>
-
-export type Fetcher<Data = unknown, SWRKey extends Key = Key> =
-  /**
-   * () => [{ foo: string }, { bar: number }] | null | undefined | false
-   * () => ( [{ foo: string }, { bar: number } ] as const | null | undefined | false )
-   */
-  SWRKey extends (() => readonly [...infer Args] | null | undefined | false)
-    ? ((...args: [...Args]) => FetcherResponse<Data>)
-    : /**
-     * [{ foo: string }, { bar: number }]
-     * [{ foo: string }, { bar: number }] as const
-     */
-    SWRKey extends (readonly [...infer Args])
-    ? ((...args: [...Args]) => FetcherResponse<Data>)
-    : /**
-     * () => string | null | undefined | false
-     * () => Record<any, any> | null | undefined | false
-     */
-    SWRKey extends (() => infer Arg | null | undefined | false)
-    ? (...args: [Arg]) => FetcherResponse<Data>
-    : /**
-     *  string | Record<any,any> | null | undefined | false
-     */
-    SWRKey extends null | undefined | false
-    ? never
-    : SWRKey extends (infer Arg)
-    ? (...args: [Arg]) => FetcherResponse<Data>
-    : never
+export type BareFetcher<Data = unknown> = (
+  ...args: any[]
+) => FetcherResponse<Data>
+export type Fetcher<
+  Data = unknown,
+  SWRKey extends Key = Key
+> = SWRKey extends (() => readonly [...infer Args] | null | undefined | false)
+  ? ((...args: [...Args]) => FetcherResponse<Data>)
+  : SWRKey extends (readonly [...infer Args])
+  ? ((...args: [...Args]) => FetcherResponse<Data>)
+  : SWRKey extends (() => infer Arg | null | undefined | false)
+  ? (...args: [Arg]) => FetcherResponse<Data>
+  : SWRKey extends null | undefined | false
+  ? never
+  : SWRKey extends (infer Arg)
+  ? (...args: [Arg]) => FetcherResponse<Data>
+  : never
 
 // Configuration types that are only used internally, not exposed to the user.
 export interface InternalConfiguration {
@@ -126,6 +115,31 @@ export interface SWRHook {
           SWRConfiguration<Data, Error, SWRKey> | undefined
         ]
   ): SWRResponse<Data, Error>
+  <Data = any, Error = any>(key: Key): SWRResponse<Data, Error>
+  <Data = any, Error = any>(
+    key: Key,
+    fetcher: BareFetcher<Data> | null
+  ): SWRResponse<Data, Error>
+  <Data = any, Error = any>(
+    key: Key,
+    config: SWRConfiguration<Data, Error> | undefined
+  ): SWRResponse<Data, Error>
+  <Data = any, Error = any>(
+    key: Key,
+    fetcher: BareFetcher<Data>,
+    config: SWRConfiguration<Data, Error> | undefined
+  ): SWRResponse<Data, Error>
+  <Data = any, Error = any>(
+    ...args:
+      | [Key]
+      | [Key, BareFetcher<Data> | null]
+      | [Key, SWRConfiguration<Data, Error> | undefined]
+      | [
+          Key,
+          BareFetcher<Data> | null,
+          SWRConfiguration<Data, Error> | undefined
+        ]
+  ): SWRResponse<Data, Error>
 }
 
 // Middlewares guarantee that a SWRHook receives a key, fetcher, and config as the argument

diff --git a/test/type/fetcher.ts b/test/type/fetcher.ts
@@ -6,6 +6,11 @@ const expectType: ExpectType = () => {}
 
 const truthy: () => boolean = () => true
 
+export function useDataErrorGeneric() {
+  useSWR<{ id: number }>('/api/', () => ({ id: 123 }))
+  useSWR<string, any>('/api/', (key: string) => key)
+}
+
 export function useString() {
   useSWR('/api/user', key => {
     expectType<string>(key)
@@ -15,6 +20,11 @@ export function useString() {
     expectType<string>(key)
     return key
   })
+
+  useSWR(truthy() ? '/api/user' : false, key => {
+    expectType<string>(key)
+    return key
+  })
 }
 
 export function useRecord() {
@@ -26,6 +36,10 @@ export function useRecord() {
     expectType<{ a: string; b: { c: string; d: number } }>(key)
     return key
   })
+  useSWR(truthy() ? { a: '1', b: { c: '3', d: 2 } } : false, key => {
+    expectType<{ a: string; b: { c: string; d: number } }>(key)
+    return key
+  })
 }
 
 export function useTuple() {
@@ -40,6 +54,13 @@ export function useTuple() {
       return keys
     }
   )
+  useSWR(
+    truthy() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : false,
+    (...keys) => {
+      expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
+      return keys
+    }
+  )
 }
 
 export function useReadonlyTuple() {
@@ -74,6 +95,23 @@ export function useReadonlyTuple() {
       return keys
     }
   )
+  useSWR(
+    truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : false,
+    (...keys) => {
+      expectType<
+        [
+          {
+            readonly a: '1'
+            readonly b: {
+              readonly c: '3'
+            }
+          },
+          readonly [1231, '888']
+        ]
+      >(keys)
+      return keys
+    }
+  )
 }
 
 export function useReturnString() {
@@ -92,6 +130,14 @@ export function useReturnString() {
     }
   )
 
+  useSWR(
+    () => (truthy() ? '/api/user' : false),
+    key => {
+      expectType<string>(key)
+      return key
+    }
+  )
+
   useSWRInfinite(
     (index, previousPageData: string) => {
       return `${index}${previousPageData}`
@@ -111,6 +157,15 @@ export function useReturnString() {
       return key
     }
   )
+  useSWRInfinite(
+    (index, previousPageData: string) => {
+      return truthy() ? `${index}${previousPageData}` : false
+    },
+    key => {
+      expectType<string>(key)
+      return key
+    }
+  )
 }
 
 export function useReturnRecord() {
@@ -129,6 +184,14 @@ export function useReturnRecord() {
     }
   )
 
+  useSWR(
+    () => (truthy() ? { a: '1', b: { c: '3', d: 2 } } : false),
+    key => {
+      expectType<{ a: string; b: { c: string; d: number } }>(key)
+      return key
+    }
+  )
+
   useSWRInfinite(
     index => ({
       index,
@@ -153,6 +216,20 @@ export function useReturnRecord() {
       return [key]
     }
   )
+
+  useSWRInfinite(
+    index =>
+      truthy()
+        ? {
+            index,
+            endPoint: '/api'
+          }
+        : false,
+    key => {
+      expectType<{ index: number; endPoint: string }>(key)
+      return [key]
+    }
+  )
 }
 
 export function useReturnTuple() {
@@ -171,6 +248,14 @@ export function useReturnTuple() {
     }
   )
 
+  useSWR(
+    () => (truthy() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : false),
+    (...keys) => {
+      expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
+      return keys
+    }
+  )
+
   useSWRInfinite(
     index => [{ a: '1', b: { c: '3', d: index } }, [1231, '888']],
     (...keys) => {
@@ -187,6 +272,15 @@ export function useReturnTuple() {
       return keys[1]
     }
   )
+
+  useSWRInfinite(
+    index =>
+      truthy() ? [{ a: '1', b: { c: '3', d: index } }, [1231, '888']] : false,
+    (...keys) => {
+      expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
+      return keys[1]
+    }
+  )
 }
 
 export function useReturnReadonlyTuple() {
@@ -226,6 +320,25 @@ export function useReturnReadonlyTuple() {
     }
   )
 
+  useSWR(
+    () =>
+      truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : false,
+    (...keys) => {
+      expectType<
+        [
+          {
+            readonly a: '1'
+            readonly b: {
+              readonly c: '3'
+            }
+          },
+          readonly [1231, '888']
+        ]
+      >(keys)
+      return keys
+    }
+  )
+
   useSWRInfinite(
     () => [{ a: '1', b: { c: '3' } }, [1231, '888']] as const,
     (...keys) => {
@@ -261,4 +374,23 @@ export function useReturnReadonlyTuple() {
       return keys[1]
     }
   )
+
+  useSWRInfinite(
+    () =>
+      truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : false,
+    (...keys) => {
+      expectType<
+        [
+          {
+            readonly a: '1'
+            readonly b: {
+              readonly c: '3'
+            }
+          },
+          readonly [1231, '888']
+        ]
+      >(keys)
+      return keys[1]
+    }
+  )
 }