@tanstack/solid-query 4.4.0

package/src/__tests__/createQuery.types.test.tsx

@@ -0,0 +1,160 @@
+import { createQuery } from '../createQuery'
+
+export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <
+  T,
+>() => T extends Y ? 1 : 2
+  ? true
+  : false
+
+export type Expect<T extends true> = T
+
+const doNotExecute = (_func: () => void) => true
+
+describe('initialData', () => {
+  describe('Config object overload', () => {
+    it('TData should always be defined when initialData is provided as an object', () => {
+      doNotExecute(() => {
+        const { data } = createQuery({
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+          initialData: {
+            wow: true,
+          },
+        })
+
+        const result: Expect<Equal<{ wow: boolean }, typeof data>> = true
+        return result
+      })
+    })
+
+    it('TData should always be defined when initialData is provided as a function which ALWAYS returns the data', () => {
+      doNotExecute(() => {
+        const { data } = createQuery({
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+          initialData: () => ({
+            wow: true,
+          }),
+        })
+
+        const result: Expect<Equal<{ wow: boolean }, typeof data>> = true
+        return result
+      })
+    })
+
+    it('TData should have undefined in the union when initialData is NOT provided', () => {
+      doNotExecute(() => {
+        const { data } = createQuery({
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+        })
+
+        const result: Expect<Equal<{ wow: boolean } | undefined, typeof data>> =
+          true
+        return result
+      })
+    })
+
+    it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => {
+      doNotExecute(() => {
+        const { data } = createQuery({
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+          initialData: () => undefined as { wow: boolean } | undefined,
+        })
+
+        const result: Expect<Equal<{ wow: boolean } | undefined, typeof data>> =
+          true
+        return result
+      })
+    })
+  })
+
+  describe('Query key overload', () => {
+    it('TData should always be defined when initialData is provided', () => {
+      doNotExecute(() => {
+        const { data } = createQuery(() => ['key'], {
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+          initialData: {
+            wow: true,
+          },
+        })
+
+        const result: Expect<Equal<{ wow: boolean }, typeof data>> = true
+        return result
+      })
+    })
+
+    it('TData should have undefined in the union when initialData is NOT provided', () => {
+      doNotExecute(() => {
+        const { data } = createQuery(() => ['key'], {
+          queryFn: () => {
+            return {
+              wow: true,
+            }
+          },
+        })
+
+        const result: Expect<Equal<{ wow: boolean } | undefined, typeof data>> =
+          true
+        return result
+      })
+    })
+  })
+
+  describe('Query key and func', () => {
+    it('TData should always be defined when initialData is provided', () => {
+      doNotExecute(() => {
+        const { data } = createQuery(
+          () => ['key'],
+          () => {
+            return {
+              wow: true,
+            }
+          },
+          {
+            initialData: {
+              wow: true,
+            },
+          },
+        )
+
+        const result: Expect<Equal<{ wow: boolean }, typeof data>> = true
+        return result
+      })
+    })
+
+    it('TData should have undefined in the union when initialData is NOT provided', () => {
+      doNotExecute(() => {
+        const { data } = createQuery(
+          () => ['key'],
+          () => {
+            return {
+              wow: true,
+            }
+          },
+        )
+
+        const result: Expect<Equal<{ wow: boolean } | undefined, typeof data>> =
+          true
+        return result
+      })
+    })
+  })
+})