@@ -103,7 +103,7 @@ function Posts(props: { setPostId: Setter
}) {
function Post(props: { postId: number; setPostId: Setter }) {
// You can even leave out the queryFn and just go straight into options
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: [`/posts/${props.postId}`],
enabled: !!props.postId,
}))
diff --git a/examples/solid/simple/src/index.tsx b/examples/solid/simple/src/index.tsx
index 3f15bde8379..26534c9953d 100644
--- a/examples/solid/simple/src/index.tsx
+++ b/examples/solid/simple/src/index.tsx
@@ -2,7 +2,7 @@
import {
QueryClient,
QueryClientProvider,
- createQuery,
+ useQuery,
} from '@tanstack/solid-query'
import { SolidQueryDevtools } from '@tanstack/solid-query-devtools'
import { Match, Switch } from 'solid-js'
@@ -20,7 +20,7 @@ export default function App() {
}
function Example() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: ['repoData'],
queryFn: async () => {
const response = await fetch(
diff --git a/examples/solid/solid-start-streaming/src/components/post-viewer.tsx b/examples/solid/solid-start-streaming/src/components/post-viewer.tsx
index 9bedf8db1e2..03aab139d7e 100644
--- a/examples/solid/solid-start-streaming/src/components/post-viewer.tsx
+++ b/examples/solid/solid-start-streaming/src/components/post-viewer.tsx
@@ -1,11 +1,11 @@
-import { createQuery } from '@tanstack/solid-query'
-import type { Component } from 'solid-js'
+import { useQuery } from '@tanstack/solid-query'
import { resetErrorBoundaries } from 'solid-js'
import { createSignal } from 'solid-js'
import { For } from 'solid-js'
-import { fetchPost } from '~/utils/api'
import { Example } from './example'
import { QueryBoundary } from './query-boundary'
+import type { Component } from 'solid-js'
+import { fetchPost } from '~/utils/api'
export interface PostViewerProps {
deferStream?: boolean
@@ -17,7 +17,7 @@ export const PostViewer: Component = (props) => {
const [simulateError, setSimulateError] = createSignal(props.simulateError)
const [postId, setPostId] = createSignal(1)
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: ['posts', postId()],
queryFn: () =>
fetchPost({
diff --git a/examples/solid/solid-start-streaming/src/components/query-boundary.tsx b/examples/solid/solid-start-streaming/src/components/query-boundary.tsx
index 48beed4621f..e904caa807d 100644
--- a/examples/solid/solid-start-streaming/src/components/query-boundary.tsx
+++ b/examples/solid/solid-start-streaming/src/components/query-boundary.tsx
@@ -1,9 +1,9 @@
-import type { CreateQueryResult } from '@tanstack/solid-query'
-import type { JSX } from 'solid-js'
import { ErrorBoundary, Match, Suspense, Switch, children } from 'solid-js'
+import type { UseQueryResult } from '@tanstack/solid-query'
+import type { JSX } from 'solid-js'
export interface QueryBoundaryProps {
- query: CreateQueryResult
+ query: UseQueryResult
/**
* Triggered when the data is initially loading.
diff --git a/examples/solid/solid-start-streaming/src/components/user-info.tsx b/examples/solid/solid-start-streaming/src/components/user-info.tsx
index d5fd910a7fa..73bb7e602c0 100644
--- a/examples/solid/solid-start-streaming/src/components/user-info.tsx
+++ b/examples/solid/solid-start-streaming/src/components/user-info.tsx
@@ -1,9 +1,9 @@
-import { createQuery } from '@tanstack/solid-query'
-import type { Component } from 'solid-js'
+import { useQuery } from '@tanstack/solid-query'
import { createSignal } from 'solid-js'
-import { fetchUser } from '~/utils/api'
import { Example } from './example'
import { QueryBoundary } from './query-boundary'
+import type { Component } from 'solid-js'
+import { fetchUser } from '~/utils/api'
export interface UserInfoProps {
deferStream?: boolean
@@ -25,7 +25,7 @@ export const userInfoQueryOpts = (props?: UserInfoProps) => ({
export const UserInfo: Component = (props) => {
const [simulateError, setSimulateError] = createSignal(props.simulateError)
- const query = createQuery(() =>
+ const query = useQuery(() =>
userInfoQueryOpts({ ...props, simulateError: simulateError() }),
)
diff --git a/examples/solid/solid-start-streaming/src/routes/batch-methods.tsx b/examples/solid/solid-start-streaming/src/routes/batch-methods.tsx
index 9c11ed99663..d6d02206c41 100644
--- a/examples/solid/solid-start-streaming/src/routes/batch-methods.tsx
+++ b/examples/solid/solid-start-streaming/src/routes/batch-methods.tsx
@@ -1,4 +1,4 @@
-import { createQuery, notifyManager } from '@tanstack/solid-query'
+import { notifyManager, useQuery } from '@tanstack/solid-query'
import { createSignal } from 'solid-js'
import { QueryBoundary } from '~/components/query-boundary'
@@ -30,7 +30,7 @@ async function sayHello(name: string) {
export default function BatchMethods() {
const [count, setCount] = createSignal(0)
- const hello = createQuery(() => ({
+ const hello = useQuery(() => ({
queryKey: ['hello', count()] as const,
queryFn: ({ queryKey: [_, count] }) => sayHello(`solid ${count}`),
}))
diff --git a/examples/solid/solid-start-streaming/src/routes/hydration.tsx b/examples/solid/solid-start-streaming/src/routes/hydration.tsx
index f924803efcf..ecdc3012c97 100644
--- a/examples/solid/solid-start-streaming/src/routes/hydration.tsx
+++ b/examples/solid/solid-start-streaming/src/routes/hydration.tsx
@@ -1,12 +1,12 @@
-import type { CreateQueryResult } from '@tanstack/solid-query'
-import { createQuery } from '@tanstack/solid-query'
-import { createSignal, Suspense } from 'solid-js'
-import { fetchUser } from '~/utils/api'
+import { useQuery } from '@tanstack/solid-query'
+import { Suspense, createSignal } from 'solid-js'
import { NoHydration } from 'solid-js/web'
import { Title } from '@solidjs/meta'
+import type { UseQueryResult } from '@tanstack/solid-query'
+import { fetchUser } from '~/utils/api'
export default function Hydration() {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: ['user'],
queryFn: () => fetchUser({ sleep: 500 }),
deferStream: true,
@@ -69,7 +69,7 @@ export default function Hydration() {
)
}
-type QueryState = CreateQueryResult<
+type QueryState = UseQueryResult<
{
id: string
name: string
diff --git a/integrations/solid-vite/src/App.jsx b/integrations/solid-vite/src/App.jsx
index 69b43f0950c..e433f36a215 100644
--- a/integrations/solid-vite/src/App.jsx
+++ b/integrations/solid-vite/src/App.jsx
@@ -1,8 +1,8 @@
import { Match, Switch } from 'solid-js'
-import { createQuery } from '@tanstack/solid-query'
+import { useQuery } from '@tanstack/solid-query'
const App = () => {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: ['test'],
queryFn: async () => {
await new Promise((r) => setTimeout(r, 1000))
diff --git a/packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx b/packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx
index 8438a425cdb..de0970819a6 100644
--- a/packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx
+++ b/packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx
@@ -1,6 +1,6 @@
import { describe, expect, test, vi } from 'vitest'
import { render, screen, waitFor } from '@solidjs/testing-library'
-import { QueryClient, createQueries, createQuery } from '@tanstack/solid-query'
+import { QueryClient, useQueries, useQuery } from '@tanstack/solid-query'
import { persistQueryClientSave } from '@tanstack/query-persist-client-core'
import { createEffect, createSignal, onMount } from 'solid-js'
@@ -69,7 +69,7 @@ describe('PersistQueryClientProvider', () => {
queryClient.clear()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -147,7 +147,7 @@ describe('PersistQueryClientProvider', () => {
queryClient.clear()
function Page() {
- const [state] = createQueries(() => ({
+ const [state] = useQueries(() => ({
queries: [
{
queryKey: key,
@@ -230,7 +230,7 @@ describe('PersistQueryClientProvider', () => {
queryClient.clear()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -315,7 +315,7 @@ describe('PersistQueryClientProvider', () => {
let fetched = false
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
fetched = true
@@ -386,7 +386,7 @@ describe('PersistQueryClientProvider', () => {
queryClient.clear()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -432,7 +432,7 @@ describe('PersistQueryClientProvider', () => {
const [error, persister] = createMockErrorPersister(removeClient)
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -530,7 +530,7 @@ describe('PersistQueryClientProvider', () => {
}
function Page() {
- const state = createQuery(() => ({ queryKey: key }))
+ const state = useQuery(() => ({ queryKey: key }))
createEffect(() =>
states.push({
diff --git a/packages/solid-query/src/__tests__/QueryClientProvider.test.tsx b/packages/solid-query/src/__tests__/QueryClientProvider.test.tsx
index e62c8a23c3f..025b6331068 100644
--- a/packages/solid-query/src/__tests__/QueryClientProvider.test.tsx
+++ b/packages/solid-query/src/__tests__/QueryClientProvider.test.tsx
@@ -1,7 +1,7 @@
import { describe, expect, it, vi } from 'vitest'
import { render, waitFor } from '@solidjs/testing-library'
import { QueryCache } from '@tanstack/query-core'
-import { QueryClientProvider, createQuery, useQueryClient } from '..'
+import { QueryClientProvider, useQuery, useQueryClient } from '..'
import { createQueryClient, queryKey, sleep } from './utils'
describe('QueryClientProvider', () => {
@@ -12,7 +12,7 @@ describe('QueryClientProvider', () => {
const queryClient = createQueryClient({ queryCache })
function Page() {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -51,7 +51,7 @@ describe('QueryClientProvider', () => {
const queryClient2 = createQueryClient({ queryCache: queryCache2 })
function Page1() {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: key1,
queryFn: async () => {
await sleep(10)
@@ -66,7 +66,7 @@ describe('QueryClientProvider', () => {
)
}
function Page2() {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: key2,
queryFn: async () => {
await sleep(10)
@@ -115,7 +115,7 @@ describe('QueryClientProvider', () => {
})
function Page() {
- const query = createQuery(() => ({
+ const query = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
diff --git a/packages/solid-query/src/__tests__/createQueries.test-d.tsx b/packages/solid-query/src/__tests__/createQueries.test-d.tsx
index c14836d273e..6c378912f60 100644
--- a/packages/solid-query/src/__tests__/createQueries.test-d.tsx
+++ b/packages/solid-query/src/__tests__/createQueries.test-d.tsx
@@ -1,8 +1,8 @@
import { describe, expectTypeOf, it } from 'vitest'
-import { createQueries, queryOptions } from '..'
-import type { CreateQueryResult } from '..'
+import { queryOptions, useQueries } from '..'
+import type { UseQueryResult } from '..'
-describe('createQueries', () => {
+describe('useQueries', () => {
it('should return correct data for dynamic queries with mixed result types', () => {
const Queries1 = {
get: () =>
@@ -20,15 +20,12 @@ describe('createQueries', () => {
}
const queries1List = [1, 2, 3].map(() => ({ ...Queries1.get() }))
- const result = createQueries(() => ({
+ const result = useQueries(() => ({
queries: [...queries1List, { ...Queries2.get() }],
}))
expectTypeOf(result).toEqualTypeOf<
- [
- ...Array>,
- CreateQueryResult,
- ]
+ [...Array>, UseQueryResult]
>()
})
})
diff --git a/packages/solid-query/src/__tests__/queryOptions.test-d.tsx b/packages/solid-query/src/__tests__/queryOptions.test-d.tsx
index 15d1133f8a8..68cfecf7afc 100644
--- a/packages/solid-query/src/__tests__/queryOptions.test-d.tsx
+++ b/packages/solid-query/src/__tests__/queryOptions.test-d.tsx
@@ -1,6 +1,6 @@
import { describe, expectTypeOf, it } from 'vitest'
import { QueryClient, dataTagSymbol, skipToken } from '@tanstack/query-core'
-import { createQuery } from '../createQuery'
+import { useQuery } from '../useQuery'
import { queryOptions } from '../queryOptions'
describe('queryOptions', () => {
@@ -22,13 +22,13 @@ describe('queryOptions', () => {
},
})
})
- it('should work when passed to createQuery', () => {
+ it('should work when passed to useQuery', () => {
const options = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
})
- const { data } = createQuery(() => options)
+ const { data } = useQuery(() => options)
expectTypeOf(data).toEqualTypeOf()
})
it('should work when passed to fetchQuery', async () => {
diff --git a/packages/solid-query/src/__tests__/suspense.test.tsx b/packages/solid-query/src/__tests__/suspense.test.tsx
index a842c42390f..5a56e072279 100644
--- a/packages/solid-query/src/__tests__/suspense.test.tsx
+++ b/packages/solid-query/src/__tests__/suspense.test.tsx
@@ -9,18 +9,9 @@ import {
createSignal,
on,
} from 'solid-js'
-import {
- QueryCache,
- QueryClientProvider,
- createInfiniteQuery,
- createQuery,
-} from '..'
+import { QueryCache, QueryClientProvider, useInfiniteQuery, useQuery } from '..'
import { createQueryClient, queryKey, sleep } from './utils'
-import type {
- CreateInfiniteQueryResult,
- CreateQueryResult,
- InfiniteData,
-} from '..'
+import type { InfiniteData, UseInfiniteQueryResult, UseQueryResult } from '..'
describe("useQuery's in Suspense mode", () => {
const queryCache = new QueryCache()
@@ -28,7 +19,7 @@ describe("useQuery's in Suspense mode", () => {
it('should render the correct amount of times in Suspense mode', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
let count = 0
let renders = 0
@@ -36,7 +27,7 @@ describe("useQuery's in Suspense mode", () => {
function Page() {
const [stateKey, setStateKey] = createSignal(key)
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: stateKey(),
queryFn: async () => {
count++
@@ -84,11 +75,11 @@ describe("useQuery's in Suspense mode", () => {
it('should return the correct states for a successful infinite query', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
const [multiplier, setMultiplier] = createSignal(1)
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: [`${key}_${multiplier()}`],
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -152,7 +143,7 @@ describe("useQuery's in Suspense mode", () => {
})
function Page() {
- createQuery(() => ({ queryKey: [key], queryFn, suspense: true }))
+ useQuery(() => ({ queryKey: [key], queryFn, suspense: true }))
return <>rendered
}
@@ -174,7 +165,7 @@ describe("useQuery's in Suspense mode", () => {
const key = queryKey()
function Page() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key,
queryFn: () => {
sleep(10)
@@ -226,7 +217,7 @@ describe("useQuery's in Suspense mode", () => {
let succeed = false
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -289,7 +280,7 @@ describe("useQuery's in Suspense mode", () => {
let succeed = false
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -350,7 +341,7 @@ describe("useQuery's in Suspense mode", () => {
let count = 0
function Component() {
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(100)
@@ -409,7 +400,7 @@ describe("useQuery's in Suspense mode", () => {
const key2 = queryKey()
function Component(props: { queryKey: Array }) {
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: props.queryKey,
queryFn: async () => {
await sleep(100)
@@ -460,7 +451,7 @@ describe("useQuery's in Suspense mode", () => {
.mockImplementation(() => undefined)
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async (): Promise => {
await sleep(10)
@@ -510,7 +501,7 @@ describe("useQuery's in Suspense mode", () => {
const key = queryKey()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async (): Promise => {
await sleep(10)
@@ -562,7 +553,7 @@ describe("useQuery's in Suspense mode", () => {
.mockImplementation(() => undefined)
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async (): Promise => {
await sleep(10)
@@ -612,7 +603,7 @@ describe("useQuery's in Suspense mode", () => {
const key = queryKey()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async (): Promise => {
await sleep(10)
@@ -669,7 +660,7 @@ describe("useQuery's in Suspense mode", () => {
function Page() {
const [enabled, setEnabled] = createSignal(false)
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: [key],
queryFn,
suspense: true,
@@ -715,7 +706,7 @@ describe("useQuery's in Suspense mode", () => {
function Page() {
const [nonce] = createSignal(0)
const queryKeys = [`${key}-${succeed}`]
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: queryKeys,
queryFn: async () => {
await sleep(10)
@@ -784,7 +775,7 @@ describe("useQuery's in Suspense mode", () => {
function Page() {
const [key, setKey] = createSignal(0)
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: [`${key()}-${succeed}`],
queryFn: async () => {
await sleep(10)
@@ -847,7 +838,7 @@ describe("useQuery's in Suspense mode", () => {
const queryKeys = '1'
const [enabled, setEnabled] = createSignal(false)
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: [queryKeys],
queryFn: async () => {
await sleep(10)
@@ -906,13 +897,13 @@ describe("useQuery's in Suspense mode", () => {
it('should render the correct amount of times in Suspense mode when gcTime is set to 0', async () => {
const key = queryKey()
- let state: CreateQueryResult | null = null
+ let state: UseQueryResult | null = null
let count = 0
let renders = 0
function Page() {
- state = createQuery(() => ({
+ state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
count++
diff --git a/packages/solid-query/src/__tests__/transition.test.tsx b/packages/solid-query/src/__tests__/transition.test.tsx
index e3ac0be7347..3a272435af8 100644
--- a/packages/solid-query/src/__tests__/transition.test.tsx
+++ b/packages/solid-query/src/__tests__/transition.test.tsx
@@ -1,10 +1,10 @@
import { describe, it } from 'vitest'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
import { Show, Suspense, createSignal, startTransition } from 'solid-js'
-import { QueryCache, QueryClientProvider, createQuery } from '..'
+import { QueryCache, QueryClientProvider, useQuery } from '..'
import { createQueryClient, queryKey, sleep } from './utils'
-describe("createQuery's in Suspense mode with transitions", () => {
+describe("useQuery's in Suspense mode with transitions", () => {
const queryCache = new QueryCache()
const queryClient = createQueryClient({ queryCache })
@@ -12,7 +12,7 @@ describe("createQuery's in Suspense mode with transitions", () => {
const key = queryKey()
function Suspended() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
diff --git a/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx b/packages/solid-query/src/__tests__/useInfiniteQuery.test.tsx
similarity index 94%
rename from packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx
rename to packages/solid-query/src/__tests__/useInfiniteQuery.test.tsx
index 54cd68f10ad..6fc070a04be 100644
--- a/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx
+++ b/packages/solid-query/src/__tests__/useInfiniteQuery.test.tsx
@@ -14,9 +14,9 @@ import {
import {
QueryCache,
QueryClientProvider,
- createInfiniteQuery,
infiniteQueryOptions,
keepPreviousData,
+ useInfiniteQuery,
} from '..'
import {
Blink,
@@ -27,9 +27,9 @@ import {
} from './utils'
import type {
- CreateInfiniteQueryResult,
InfiniteData,
QueryFunctionContext,
+ UseInfiniteQueryResult,
} from '..'
import type { Mock } from 'vitest'
@@ -63,10 +63,10 @@ describe('useInfiniteQuery', () => {
it('should return the correct states for a successful query', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) => Number(pageParam),
getNextPageParam: (lastPage) => lastPage + 1,
@@ -166,7 +166,7 @@ describe('useInfiniteQuery', () => {
function Page() {
const start = 1
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) => {
if (pageParam === 2) {
@@ -206,14 +206,13 @@ describe('useInfiniteQuery', () => {
it('should keep the previous data when placeholderData is set', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
const [order, setOrder] = createSignal('desc')
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: [key, order()],
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -306,10 +305,10 @@ describe('useInfiniteQuery', () => {
it('should be able to select a part of the data', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: () => ({ count: 1 }),
select: (data) => ({
@@ -347,12 +346,12 @@ describe('useInfiniteQuery', () => {
it('should be able to select a new result and not cause infinite renders', async () => {
const key = queryKey()
const states: Array<
- CreateInfiniteQueryResult>
+ UseInfiniteQueryResult>
> = []
let selectCalled = 0
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: () => ({ count: 1 }),
select: (data: InfiniteData<{ count: number }>) => {
@@ -393,12 +392,11 @@ describe('useInfiniteQuery', () => {
it('should be able to reverse the data', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -469,13 +467,12 @@ describe('useInfiniteQuery', () => {
it('should be able to fetch a previous page', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
const start = 10
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -558,12 +555,11 @@ describe('useInfiniteQuery', () => {
it('should be able to refetch when providing page params automatically', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -682,14 +678,13 @@ describe('useInfiniteQuery', () => {
it('should return the correct states when refetch fails', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
let isRefetch = false
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -795,12 +790,11 @@ describe('useInfiniteQuery', () => {
it('should return the correct states when fetchNextPage fails', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -899,12 +893,11 @@ describe('useInfiniteQuery', () => {
it('should return the correct states when fetchPreviousPage fails', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -1007,13 +1000,12 @@ describe('useInfiniteQuery', () => {
it('should silently cancel any ongoing fetch when fetching more', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
const start = 10
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(50)
@@ -1114,7 +1106,7 @@ describe('useInfiniteQuery', () => {
})
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: fetchPage,
getNextPageParam: (lastPage) => lastPage + 1,
@@ -1195,7 +1187,7 @@ describe('useInfiniteQuery', () => {
})
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: fetchPage,
getNextPageParam: (lastPage) => lastPage + 1,
@@ -1249,11 +1241,11 @@ describe('useInfiniteQuery', () => {
it('should keep fetching first page when not loaded yet and triggering fetch more', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
const start = 10
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(50)
@@ -1311,7 +1303,7 @@ describe('useInfiniteQuery', () => {
const initialData = { pages: [1, 2, 3, 4], pageParams: [0, 1, 2, 3] }
function List() {
- createInfiniteQuery(() => ({
+ useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam, signal: _ }) => {
fetches++
@@ -1359,14 +1351,13 @@ describe('useInfiniteQuery', () => {
it('should be able to set new pages with the query client', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
const [firstPage, setFirstPage] = createSignal(0)
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }) => {
await sleep(10)
@@ -1455,12 +1446,11 @@ describe('useInfiniteQuery', () => {
it('should only refetch the first page when initialData is provided', async () => {
const key = queryKey()
- const states: Array<
- Partial>>
- > = []
+ const states: Array>>> =
+ []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: async ({ pageParam }): Promise => {
await sleep(10)
@@ -1534,10 +1524,10 @@ describe('useInfiniteQuery', () => {
it('should set hasNextPage to false if getNextPageParam returns undefined', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) => Number(pageParam),
initialPageParam: 1,
@@ -1578,10 +1568,10 @@ describe('useInfiniteQuery', () => {
it('should compute hasNextPage correctly using initialData', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }): number => pageParam,
initialPageParam: 10,
@@ -1622,10 +1612,10 @@ describe('useInfiniteQuery', () => {
it('should compute hasNextPage correctly for falsy getFetchMore return value using initialData', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }): number => pageParam,
initialPageParam: 10,
@@ -1666,10 +1656,10 @@ describe('useInfiniteQuery', () => {
it('should not use selected data when computing hasNextPage', async () => {
const key = queryKey()
- const states: Array>> = []
+ const states: Array>> = []
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) => Number(pageParam),
initialPageParam: 1,
@@ -1731,7 +1721,7 @@ describe('useInfiniteQuery', () => {
function Page() {
let fetchCountRef = 0
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) =>
fetchItemsWithLimit(pageParam, fetchCountRef++),
@@ -1861,7 +1851,7 @@ describe('useInfiniteQuery', () => {
let fetchCountRef = 0
const [isRemovedLastPage, setIsRemovedLastPage] =
createSignal(false)
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn: ({ pageParam }) =>
fetchItems(
@@ -1999,7 +1989,7 @@ describe('useInfiniteQuery', () => {
}
function Page() {
- const state = createInfiniteQuery(() => ({
+ const state = useInfiniteQuery(() => ({
queryKey: key,
queryFn,
getNextPageParam: () => undefined,
@@ -2032,7 +2022,7 @@ describe('useInfiniteQuery', () => {
}
function Page() {
- const state = createInfiniteQuery(
+ const state = useInfiniteQuery(
() => ({
queryKey: key,
queryFn,
@@ -2066,7 +2056,7 @@ describe('useInfiniteQuery', () => {
})
function Page() {
- const state = createInfiniteQuery(
+ const state = useInfiniteQuery(
() => options,
() => queryClient,
)
diff --git a/packages/solid-query/src/__tests__/useIsFetching.test.tsx b/packages/solid-query/src/__tests__/useIsFetching.test.tsx
index 8aafbec8fcc..02fab631414 100644
--- a/packages/solid-query/src/__tests__/useIsFetching.test.tsx
+++ b/packages/solid-query/src/__tests__/useIsFetching.test.tsx
@@ -1,7 +1,7 @@
import { describe, expect, it } from 'vitest'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
import { Show, createEffect, createRenderEffect, createSignal } from 'solid-js'
-import { QueryCache, QueryClientProvider, createQuery, useIsFetching } from '..'
+import { QueryCache, QueryClientProvider, useIsFetching, useQuery } from '..'
import { createQueryClient, queryKey, setActTimeout, sleep } from './utils'
describe('useIsFetching', () => {
@@ -19,7 +19,7 @@ describe('useIsFetching', () => {
function Query() {
const [ready, setReady] = createSignal(false)
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(50)
@@ -70,7 +70,7 @@ describe('useIsFetching', () => {
}
function FirstQuery() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key1,
queryFn: async () => {
await sleep(150)
@@ -81,7 +81,7 @@ describe('useIsFetching', () => {
}
function SecondQuery() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key2,
queryFn: async () => {
await sleep(200)
@@ -128,7 +128,7 @@ describe('useIsFetching', () => {
const isFetchingArray: Array = []
function One() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key1,
queryFn: async () => {
await sleep(10)
@@ -139,7 +139,7 @@ describe('useIsFetching', () => {
}
function Two() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key2,
queryFn: async () => {
await sleep(20)
@@ -192,7 +192,7 @@ describe('useIsFetching', () => {
const key = queryKey()
function Page() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -224,7 +224,7 @@ describe('useIsFetching', () => {
const key = queryKey()
function Page() {
- createQuery(
+ useQuery(
() => ({
queryKey: key,
queryFn: async () => {
diff --git a/packages/solid-query/src/__tests__/useIsMutating.test.tsx b/packages/solid-query/src/__tests__/useIsMutating.test.tsx
index ed2a0719cb6..efd6eaf83a6 100644
--- a/packages/solid-query/src/__tests__/useIsMutating.test.tsx
+++ b/packages/solid-query/src/__tests__/useIsMutating.test.tsx
@@ -2,7 +2,7 @@ import { describe, expect, it, vi } from 'vitest'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
import { Show, createEffect, createRenderEffect, createSignal } from 'solid-js'
import * as QueryCore from '@tanstack/query-core'
-import { QueryClientProvider, createMutation, useIsMutating } from '..'
+import { QueryClientProvider, useIsMutating, useMutation } from '..'
import { createQueryClient, setActTimeout, sleep } from './utils'
describe('useIsMutating', () => {
@@ -19,14 +19,14 @@ describe('useIsMutating', () => {
}
function Mutations() {
- const { mutate: mutate1 } = createMutation(() => ({
+ const { mutate: mutate1 } = useMutation(() => ({
mutationKey: ['mutation1'],
mutationFn: async () => {
await sleep(150)
return 'data'
},
}))
- const { mutate: mutate2 } = createMutation(() => ({
+ const { mutate: mutate2 } = useMutation(() => ({
mutationKey: ['mutation2'],
mutationFn: async () => {
await sleep(50)
@@ -74,14 +74,14 @@ describe('useIsMutating', () => {
}
function Page() {
- const { mutate: mutate1 } = createMutation(() => ({
+ const { mutate: mutate1 } = useMutation(() => ({
mutationKey: ['mutation1'],
mutationFn: async () => {
await sleep(100)
return 'data'
},
}))
- const { mutate: mutate2 } = createMutation(() => ({
+ const { mutate: mutate2 } = useMutation(() => ({
mutationKey: ['mutation2'],
mutationFn: async () => {
await sleep(100)
@@ -122,14 +122,14 @@ describe('useIsMutating', () => {
}
function Page() {
- const { mutate: mutate1 } = createMutation(() => ({
+ const { mutate: mutate1 } = useMutation(() => ({
mutationKey: ['mutation1'],
mutationFn: async () => {
await sleep(100)
return 'data'
},
}))
- const { mutate: mutate2 } = createMutation(() => ({
+ const { mutate: mutate2 } = useMutation(() => ({
mutationKey: ['mutation2'],
mutationFn: async () => {
await sleep(100)
@@ -160,7 +160,7 @@ describe('useIsMutating', () => {
function Page() {
const isMutating = useIsMutating(undefined, () => queryClient)
- const { mutate } = createMutation(
+ const { mutate } = useMutation(
() => ({
mutationKey: ['mutation1'],
mutationFn: async () => {
@@ -210,7 +210,7 @@ describe('useIsMutating', () => {
function Page() {
const [mounted, setMounted] = createSignal(true)
- const { mutate: mutate1 } = createMutation(() => ({
+ const { mutate: mutate1 } = useMutation(() => ({
mutationKey: ['mutation1'],
mutationFn: async () => {
await sleep(10)
diff --git a/packages/solid-query/src/__tests__/createMutation.test.tsx b/packages/solid-query/src/__tests__/useMutation.test.tsx
similarity index 95%
rename from packages/solid-query/src/__tests__/createMutation.test.tsx
rename to packages/solid-query/src/__tests__/useMutation.test.tsx
index 764b9c0c223..3a80e4b45f7 100644
--- a/packages/solid-query/src/__tests__/createMutation.test.tsx
+++ b/packages/solid-query/src/__tests__/useMutation.test.tsx
@@ -6,12 +6,7 @@ import {
createSignal,
} from 'solid-js'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
-import {
- MutationCache,
- QueryCache,
- QueryClientProvider,
- createMutation,
-} from '..'
+import { MutationCache, QueryCache, QueryClientProvider, useMutation } from '..'
import {
createQueryClient,
mockOnlineManagerIsOnline,
@@ -19,16 +14,16 @@ import {
setActTimeout,
sleep,
} from './utils'
-import type { CreateMutationResult } from '../types'
+import type { UseMutationResult } from '../types'
-describe('createMutation', () => {
+describe('useMutation', () => {
const queryCache = new QueryCache()
const mutationCache = new MutationCache()
const queryClient = createQueryClient({ queryCache, mutationCache })
it('should be able to reset `data`', async () => {
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: () => Promise.resolve('mutation'),
}))
@@ -68,7 +63,7 @@ describe('createMutation', () => {
.mockImplementation(() => undefined)
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: () => {
const err = new Error('Expected mock error. All is well!')
err.stack = ''
@@ -118,7 +113,7 @@ describe('createMutation', () => {
const onSettledMock = vi.fn()
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: (vars: { count: number }) => Promise.resolve(vars.count),
onSuccess: (data) => {
onSuccessMock(data)
@@ -192,7 +187,7 @@ describe('createMutation', () => {
})
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: mutateFn,
}))
@@ -242,7 +237,7 @@ describe('createMutation', () => {
const [count, setCount] = createSignal(0)
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: (vars: { count: number }) => {
const error = new Error(
`Expected mock error. All is well! ${vars.count}`,
@@ -320,7 +315,7 @@ describe('createMutation', () => {
const callbacks: Array = []
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (text: string) => text,
onSuccess: async () => {
callbacks.push('useMutation.onSuccess')
@@ -371,7 +366,7 @@ describe('createMutation', () => {
const callbacks: Array = []
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => Promise.reject(new Error('oops')),
onError: async () => {
@@ -430,10 +425,10 @@ describe('createMutation', () => {
},
})
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationKey: key,
}))
@@ -469,7 +464,7 @@ describe('createMutation', () => {
let count = 0
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: (_text: string) => {
count++
return Promise.reject(new Error('oops'))
@@ -505,7 +500,7 @@ describe('createMutation', () => {
let count = 0
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: (_text: string) => {
count++
return Promise.reject(new Error('oops'))
@@ -572,7 +567,7 @@ describe('createMutation', () => {
let count = 0
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
count++
await sleep(10)
@@ -624,7 +619,7 @@ describe('createMutation', () => {
const states: Array = []
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
count++
await sleep(10)
@@ -675,10 +670,10 @@ describe('createMutation', () => {
const onlineMock = mockOnlineManagerIsOnline(false)
let count = 0
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
await sleep(1)
count++
@@ -763,7 +758,7 @@ describe('createMutation', () => {
it('should not change state if unmounted', async () => {
function Mutates() {
- const mutation = createMutation(() => ({ mutationFn: () => sleep(10) }))
+ const mutation = useMutation(() => ({ mutationFn: () => sleep(10) }))
return
}
function Page() {
@@ -791,7 +786,7 @@ describe('createMutation', () => {
.mockImplementation(() => undefined)
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: () => {
const err = new Error('Expected mock error. All is well!')
err.stack = ''
@@ -837,7 +832,7 @@ describe('createMutation', () => {
let boundary = false
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: () => {
const err = new Error('mock error')
err.stack = ''
@@ -905,11 +900,11 @@ describe('createMutation', () => {
const metaErrorMessage = 'mutation failed'
function Page() {
- const mutationSucceed = createMutation(() => ({
+ const mutationSucceed = useMutation(() => ({
mutationFn: async () => '',
meta: { metaSuccessMessage },
}))
- const mutationError = createMutation(() => ({
+ const mutationError = useMutation(() => ({
mutationFn: async () => {
throw new Error('')
},
@@ -965,7 +960,7 @@ describe('createMutation', () => {
}
function Component() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
count++
await sleep(10)
@@ -1030,7 +1025,7 @@ describe('createMutation', () => {
let count = 0
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
count++
await sleep(10)
@@ -1092,7 +1087,7 @@ describe('createMutation', () => {
const onError = vi.fn()
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
await sleep(10)
return 'result'
@@ -1129,7 +1124,7 @@ describe('createMutation', () => {
const mutateFnError = new Error('mutateFnError')
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
await sleep(10)
throw mutateFnError
@@ -1168,7 +1163,7 @@ describe('createMutation', () => {
const onError = vi.fn()
function Page() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationFn: async (_text: string) => {
await sleep(10)
throw mutateFnError
@@ -1206,7 +1201,7 @@ describe('createMutation', () => {
it('should use provided custom queryClient', async () => {
function Page() {
- const mutation = createMutation(
+ const mutation = useMutation(
() => ({
mutationFn: async (text: string) => {
return Promise.resolve(text)
diff --git a/packages/solid-query/src/__tests__/useMutationState.test.tsx b/packages/solid-query/src/__tests__/useMutationState.test.tsx
index 22d0d9653c8..2ba5cdb6483 100644
--- a/packages/solid-query/src/__tests__/useMutationState.test.tsx
+++ b/packages/solid-query/src/__tests__/useMutationState.test.tsx
@@ -2,7 +2,7 @@ import { describe, expect, it } from 'vitest'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
import { createEffect } from 'solid-js'
import { useMutationState } from '../useMutationState'
-import { createMutation } from '../createMutation'
+import { useMutation } from '../useMutation'
import { QueryClientProvider } from '../QueryClientProvider'
import { createQueryClient, sleep } from './utils'
@@ -26,7 +26,7 @@ describe('useMutationState', () => {
}
function Mutate() {
- const mutation = createMutation(() => ({
+ const mutation = useMutation(() => ({
mutationKey,
mutationFn: async (input: number) => {
await sleep(150)
diff --git a/packages/solid-query/src/__tests__/createQueries.test.tsx b/packages/solid-query/src/__tests__/useQueries.test.tsx
similarity index 81%
rename from packages/solid-query/src/__tests__/createQueries.test.tsx
rename to packages/solid-query/src/__tests__/useQueries.test.tsx
index f34fae0b391..46ee666d425 100644
--- a/packages/solid-query/src/__tests__/createQueries.test.tsx
+++ b/packages/solid-query/src/__tests__/useQueries.test.tsx
@@ -6,11 +6,11 @@ import {
QueriesObserver,
QueryCache,
QueryClientProvider,
- createQueries,
+ useQueries,
} from '..'
import { createQueryClient, queryKey, sleep } from './utils'
import type { QueryFunctionContext, QueryKey } from '@tanstack/query-core'
-import type { CreateQueryResult, QueryFunction, SolidQueryOptions } from '..'
+import type { QueryFunction, SolidQueryOptions, UseQueryResult } from '..'
describe('useQueries', () => {
const queryCache = new QueryCache()
@@ -19,10 +19,10 @@ describe('useQueries', () => {
it('should return the correct states', async () => {
const key1 = queryKey()
const key2 = queryKey()
- const results: Array> = []
+ const results: Array> = []
function Page() {
- const result = createQueries(() => ({
+ const result = useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -76,7 +76,7 @@ describe('useQueries', () => {
// @ts-expect-error (Page component is not rendered)
function Page() {
- const result1 = createQueries<
+ const result1 = useQueries<
[[number], [string], [Array, boolean]]
>(() => ({
queries: [
@@ -94,10 +94,10 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result1[0]).toEqualTypeOf>()
- expectTypeOf(result1[1]).toEqualTypeOf>()
+ expectTypeOf(result1[0]).toEqualTypeOf>()
+ expectTypeOf(result1[1]).toEqualTypeOf>()
expectTypeOf(result1[2]).toEqualTypeOf<
- CreateQueryResult, boolean>
+ UseQueryResult, boolean>
>()
expectTypeOf(result1[0].data).toEqualTypeOf()
expectTypeOf(result1[1].data).toEqualTypeOf()
@@ -105,7 +105,7 @@ describe('useQueries', () => {
expectTypeOf(result1[2].error).toEqualTypeOf()
// TData (3rd element) takes precedence over TQueryFnData (1st element)
- const result2 = createQueries<
+ const result2 = useQueries<
[[string, unknown, string], [string, unknown, number]]
>(() => ({
queries: [
@@ -127,17 +127,13 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result2[0]).toEqualTypeOf<
- CreateQueryResult
- >()
- expectTypeOf(result2[1]).toEqualTypeOf<
- CreateQueryResult
- >()
+ expectTypeOf(result2[0]).toEqualTypeOf>()
+ expectTypeOf(result2[1]).toEqualTypeOf>()
expectTypeOf(result2[0].data).toEqualTypeOf()
expectTypeOf(result2[1].data).toEqualTypeOf()
// types should be enforced
- createQueries<[[string, unknown, string], [string, boolean, number]]>(
+ useQueries<[[string, unknown, string], [string, boolean, number]]>(
() => ({
queries: [
{
@@ -167,7 +163,7 @@ describe('useQueries', () => {
)
// field names should be enforced
- createQueries<[[string]]>(() => ({
+ useQueries<[[string]]>(() => ({
queries: [
{
queryKey: key1,
@@ -185,7 +181,7 @@ describe('useQueries', () => {
// @ts-expect-error (Page component is not rendered)
function Page() {
- const result1 = createQueries<
+ const result1 = useQueries<
[
{ queryFnData: number },
{ queryFnData: string },
@@ -207,14 +203,10 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result1[0]).toEqualTypeOf<
- CreateQueryResult
- >()
- expectTypeOf(result1[1]).toEqualTypeOf<
- CreateQueryResult
- >()
+ expectTypeOf(result1[0]).toEqualTypeOf>()
+ expectTypeOf(result1[1]).toEqualTypeOf>()
expectTypeOf(result1[2]).toEqualTypeOf<
- CreateQueryResult, boolean>
+ UseQueryResult, boolean>
>()
expectTypeOf(result1[0].data).toEqualTypeOf()
expectTypeOf(result1[1].data).toEqualTypeOf()
@@ -222,7 +214,7 @@ describe('useQueries', () => {
expectTypeOf(result1[2].error).toEqualTypeOf()
// TData (data prop) takes precedence over TQueryFnData (queryFnData prop)
- const result2 = createQueries<
+ const result2 = useQueries<
[
{ queryFnData: string; data: string },
{ queryFnData: string; data: number },
@@ -247,49 +239,39 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result2[0]).toEqualTypeOf<
- CreateQueryResult
- >()
- expectTypeOf(result2[1]).toEqualTypeOf<
- CreateQueryResult
- >()
+ expectTypeOf(result2[0]).toEqualTypeOf>()
+ expectTypeOf(result2[1]).toEqualTypeOf>()
expectTypeOf(result2[0].data).toEqualTypeOf()
expectTypeOf(result2[1].data).toEqualTypeOf()
// can pass only TData (data prop) although TQueryFnData will be left unknown
- const result3 = createQueries<[{ data: string }, { data: number }]>(
- () => ({
- queries: [
- {
- queryKey: key1,
- queryFn: () => 'string',
- select: (a) => {
- expectTypeOf(a).toEqualTypeOf()
- return a as string
- },
+ const result3 = useQueries<[{ data: string }, { data: number }]>(() => ({
+ queries: [
+ {
+ queryKey: key1,
+ queryFn: () => 'string',
+ select: (a) => {
+ expectTypeOf(a).toEqualTypeOf()
+ return a as string
},
- {
- queryKey: key2,
- queryFn: () => 'string',
- select: (a) => {
- expectTypeOf(a).toEqualTypeOf()
- return a as number
- },
+ },
+ {
+ queryKey: key2,
+ queryFn: () => 'string',
+ select: (a) => {
+ expectTypeOf(a).toEqualTypeOf()
+ return a as number
},
- ],
- }),
- )
- expectTypeOf(result3[0]).toEqualTypeOf<
- CreateQueryResult
- >()
- expectTypeOf(result3[1]).toEqualTypeOf<
- CreateQueryResult
- >()
+ },
+ ],
+ }))
+ expectTypeOf(result3[0]).toEqualTypeOf>()
+ expectTypeOf(result3[1]).toEqualTypeOf>()
expectTypeOf(result3[0].data).toEqualTypeOf()
expectTypeOf(result3[1].data).toEqualTypeOf()
// types should be enforced
- createQueries<
+ useQueries<
[
{ queryFnData: string; data: string },
{ queryFnData: string; data: number; error: boolean },
@@ -322,7 +304,7 @@ describe('useQueries', () => {
}))
// field names should be enforced
- createQueries<[{ queryFnData: string }]>(() => ({
+ useQueries<[{ queryFnData: string }]>(() => ({
queries: [
{
queryKey: key1,
@@ -342,21 +324,21 @@ describe('useQueries', () => {
// @ts-expect-error (Page component is not rendered)
function Page() {
// Array.map preserves TQueryFnData
- const result1 = createQueries(() => ({
+ const result1 = useQueries(() => ({
queries: Array(50).map((_, i) => ({
queryKey: ['key', i] as const,
queryFn: () => i + 10,
})),
}))
expectTypeOf(result1).toEqualTypeOf<
- Array>
+ Array>
>()
if (result1[0]) {
expectTypeOf(result1[0].data).toEqualTypeOf()
}
// Array.map preserves TData
- const result2 = createQueries(() => ({
+ const result2 = useQueries(() => ({
queries: Array(50).map((_, i) => ({
queryKey: ['key', i] as const,
queryFn: () => i + 10,
@@ -364,10 +346,10 @@ describe('useQueries', () => {
})),
}))
expectTypeOf(result2).toEqualTypeOf<
- Array>
+ Array>
>()
- const result3 = createQueries(() => ({
+ const result3 = useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -384,16 +366,16 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result3[0]).toEqualTypeOf>()
- expectTypeOf(result3[1]).toEqualTypeOf>()
- expectTypeOf(result3[2]).toEqualTypeOf>()
+ expectTypeOf(result3[0]).toEqualTypeOf>()
+ expectTypeOf(result3[1]).toEqualTypeOf>()
+ expectTypeOf(result3[2]).toEqualTypeOf>()
expectTypeOf(result3[0].data).toEqualTypeOf()
expectTypeOf(result3[1].data).toEqualTypeOf()
// select takes precedence over queryFn
expectTypeOf(result3[2].data).toEqualTypeOf()
// initialData/placeholderData are enforced
- createQueries(() => ({
+ useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -413,7 +395,7 @@ describe('useQueries', () => {
}))
// select params are "indirectly" enforced
- createQueries(() => ({
+ useQueries(() => ({
queries: [
// unfortunately TS will not suggest the type for you
{
@@ -439,7 +421,7 @@ describe('useQueries', () => {
}))
// callbacks are also indirectly enforced with Array.map
- createQueries(() => ({
+ useQueries(() => ({
queries: Array(50).map((_, i) => ({
queryKey: ['key', i] as const,
queryFn: () => i + 10,
@@ -447,7 +429,7 @@ describe('useQueries', () => {
})),
}))
- createQueries(() => ({
+ useQueries(() => ({
queries: Array(50).map((_, i) => ({
queryKey: ['key', i] as const,
queryFn: () => i + 10,
@@ -456,7 +438,7 @@ describe('useQueries', () => {
}))
// results inference works when all the handlers are defined
- const result4 = createQueries(() => ({
+ const result4 = useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -473,12 +455,12 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result4[0]).toEqualTypeOf>()
- expectTypeOf(result4[1]).toEqualTypeOf>()
- expectTypeOf(result4[2]).toEqualTypeOf>()
+ expectTypeOf(result4[0]).toEqualTypeOf>()
+ expectTypeOf(result4[1]).toEqualTypeOf>()
+ expectTypeOf(result4[2]).toEqualTypeOf>()
// handles when queryFn returns a Promise
- const result5 = createQueries(() => ({
+ const result5 = useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -486,10 +468,10 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result5[0]).toEqualTypeOf>()
+ expectTypeOf(result5[0]).toEqualTypeOf>()
// Array as const does not throw error
- const result6 = createQueries(
+ const result6 = useQueries(
() =>
({
queries: [
@@ -504,11 +486,11 @@ describe('useQueries', () => {
],
}) as const,
)
- expectTypeOf(result6[0]).toEqualTypeOf>()
- expectTypeOf(result6[1]).toEqualTypeOf>()
+ expectTypeOf(result6[0]).toEqualTypeOf>()
+ expectTypeOf(result6[1]).toEqualTypeOf>()
// field names should be enforced - array literal
- createQueries(() => ({
+ useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -518,7 +500,7 @@ describe('useQueries', () => {
}))
// field names should be enforced - Array.map() result
- createQueries(() => ({
+ useQueries(() => ({
// @ts-expect-error (invalidField)
queries: Array(10).map(() => ({
someInvalidField: '',
@@ -526,7 +508,7 @@ describe('useQueries', () => {
}))
// field names should be enforced - array literal
- createQueries(() => ({
+ useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -536,7 +518,7 @@ describe('useQueries', () => {
}))
// supports queryFn using fetch() to return Promise - Array.map() result
- createQueries(() => ({
+ useQueries(() => ({
queries: Array(50).map((_, i) => ({
queryKey: ['key', i] as const,
queryFn: () =>
@@ -545,7 +527,7 @@ describe('useQueries', () => {
}))
// supports queryFn using fetch() to return Promise - array literal
- createQueries(() => ({
+ useQueries(() => ({
queries: [
{
queryKey: key1,
@@ -586,7 +568,7 @@ describe('useQueries', () => {
>(
queries: Array>,
) {
- return createQueries(() => ({
+ return useQueries(() => ({
queries: queries.map(
// no need to type the mapped query
(query) => {
@@ -616,7 +598,7 @@ describe('useQueries', () => {
// @ts-expect-error (Page component is not rendered)
function Page() {
- const result = createQueries(() => ({
+ const result = useQueries(() => ({
queries: [
{
queryKey: getQueryKeyA(),
@@ -628,10 +610,10 @@ describe('useQueries', () => {
},
],
}))
- expectTypeOf(result[0]).toEqualTypeOf>()
- expectTypeOf(result[1]).toEqualTypeOf>()
+ expectTypeOf(result[0]).toEqualTypeOf>()
+ expectTypeOf(result[1]).toEqualTypeOf>()
- const withSelector = createQueries(() => ({
+ const withSelector = useQueries(() => ({
queries: [
{
queryKey: getQueryKeyA(),
@@ -646,10 +628,10 @@ describe('useQueries', () => {
],
}))
expectTypeOf(withSelector[0]).toEqualTypeOf<
- CreateQueryResult<[number, string], Error>
+ UseQueryResult<[number, string], Error>
>()
expectTypeOf(withSelector[1]).toEqualTypeOf<
- CreateQueryResult<[string, number], Error>
+ UseQueryResult<[string, number], Error>
>()
const withWrappedQueries = useWrappedQueries(
@@ -661,7 +643,7 @@ describe('useQueries', () => {
)
expectTypeOf(withWrappedQueries).toEqualTypeOf<
- Array>
+ Array>
>()
}
})
@@ -685,7 +667,7 @@ describe('useQueries', () => {
})
function Queries() {
- createQueries(() => ({
+ useQueries(() => ({
queries: [
{
queryKey: key1,
diff --git a/packages/solid-query/src/__tests__/createQuery.test-d.tsx b/packages/solid-query/src/__tests__/useQuery.test-d.tsx
similarity index 85%
rename from packages/solid-query/src/__tests__/createQuery.test-d.tsx
rename to packages/solid-query/src/__tests__/useQuery.test-d.tsx
index 91717c34d7a..79ea46d43c1 100644
--- a/packages/solid-query/src/__tests__/createQuery.test-d.tsx
+++ b/packages/solid-query/src/__tests__/useQuery.test-d.tsx
@@ -1,10 +1,10 @@
import { describe, expectTypeOf, it } from 'vitest'
-import { createQuery, queryOptions } from '../index'
+import { queryOptions, useQuery } from '../index'
describe('initialData', () => {
describe('Config object overload', () => {
it('TData should always be defined when initialData is provided as an object', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: { wow: true },
@@ -19,13 +19,13 @@ describe('initialData', () => {
queryFn: () => ({ wow: true }),
initialData: { wow: true },
})
- const { data } = createQuery(() => options)
+ const { data } = useQuery(() => options)
expectTypeOf(data).toEqualTypeOf<{ wow: boolean }>()
})
it('TData should always be defined when initialData is provided as a function which ALWAYS returns the data', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: () => ({ wow: true }),
@@ -35,7 +35,7 @@ describe('initialData', () => {
})
it('TData should have undefined in the union when initialData is NOT provided', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
}))
@@ -44,7 +44,7 @@ describe('initialData', () => {
})
it('TData should have undefined in the union when initialData is provided as a function which can return undefined', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: () => undefined as { wow: boolean } | undefined,
@@ -56,7 +56,7 @@ describe('initialData', () => {
describe('Query key overload', () => {
it('TData should always be defined when initialData is provided', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: { wow: true },
@@ -66,7 +66,7 @@ describe('initialData', () => {
})
it('TData should have undefined in the union when initialData is NOT provided', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
}))
@@ -77,7 +77,7 @@ describe('initialData', () => {
describe('Query key and func', () => {
it('TData should always be defined when initialData is provided', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
initialData: { wow: true },
@@ -87,7 +87,7 @@ describe('initialData', () => {
})
it('TData should have undefined in the union when initialData is NOT provided', () => {
- const { data } = createQuery(() => ({
+ const { data } = useQuery(() => ({
queryKey: ['key'],
queryFn: () => ({ wow: true }),
}))
diff --git a/packages/solid-query/src/__tests__/createQuery.test.tsx b/packages/solid-query/src/__tests__/useQuery.test.tsx
similarity index 93%
rename from packages/solid-query/src/__tests__/createQuery.test.tsx
rename to packages/solid-query/src/__tests__/useQuery.test.tsx
index 60e1df1aefb..70914603b7d 100644
--- a/packages/solid-query/src/__tests__/createQuery.test.tsx
+++ b/packages/solid-query/src/__tests__/useQuery.test.tsx
@@ -11,12 +11,7 @@ import {
} from 'solid-js'
import { fireEvent, render, waitFor } from '@solidjs/testing-library'
import { reconcile } from 'solid-js/store'
-import {
- QueryCache,
- QueryClientProvider,
- createQuery,
- keepPreviousData,
-} from '..'
+import { QueryCache, QueryClientProvider, keepPreviousData, useQuery } from '..'
import {
Blink,
createQueryClient,
@@ -27,16 +22,16 @@ import {
sleep,
} from './utils'
import type {
- CreateQueryOptions,
- CreateQueryResult,
- DefinedCreateQueryResult,
+ DefinedUseQueryResult,
OmitKeyof,
QueryFunction,
+ UseQueryOptions,
+ UseQueryResult,
} from '..'
import type { Mock } from 'vitest'
import type { JSX } from 'solid-js'
-describe('createQuery', () => {
+describe('useQuery', () => {
const queryCache = new QueryCache()
const queryClient = createQueryClient({ queryCache })
@@ -46,12 +41,12 @@ describe('createQuery', () => {
// @ts-expect-error
function Page() {
// unspecified query function should default to unknown
- const noQueryFn = createQuery(() => ({ queryKey: key }))
+ const noQueryFn = useQuery(() => ({ queryKey: key }))
expectTypeOf(noQueryFn.data).toEqualTypeOf()
expectTypeOf(noQueryFn.error).toEqualTypeOf()
// it should infer the result type from the query function
- const fromQueryFn = createQuery(() => ({
+ const fromQueryFn = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
}))
@@ -59,7 +54,7 @@ describe('createQuery', () => {
expectTypeOf(fromQueryFn.error).toEqualTypeOf()
// it should be possible to specify the result type
- const withResult = createQuery(() => ({
+ const withResult = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
}))
@@ -67,7 +62,7 @@ describe('createQuery', () => {
expectTypeOf(withResult.error).toEqualTypeOf()
// it should be possible to specify the error type
- const withError = createQuery(() => ({
+ const withError = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
}))
@@ -75,18 +70,18 @@ describe('createQuery', () => {
expectTypeOf(withError.error).toEqualTypeOf()
// it should provide the result type in the configuration
- createQuery(() => ({
+ useQuery(() => ({
queryKey: [key],
queryFn: async () => true,
}))
// it should be possible to specify a union type as result type
- const unionTypeSync = createQuery(() => ({
+ const unionTypeSync = useQuery(() => ({
queryKey: key,
queryFn: () => (Math.random() > 0.5 ? ('a' as const) : ('b' as const)),
}))
expectTypeOf(unionTypeSync.data).toEqualTypeOf<'a' | 'b' | undefined>()
- const unionTypeAsync = createQuery<'a' | 'b'>(() => ({
+ const unionTypeAsync = useQuery<'a' | 'b'>(() => ({
queryKey: key,
queryFn: () => Promise.resolve(Math.random() > 0.5 ? 'a' : 'b'),
}))
@@ -94,21 +89,21 @@ describe('createQuery', () => {
// should error when the query function result does not match with the specified type
// @ts-expect-error
- createQuery(() => ({ queryKey: key, queryFn: () => 'test' }))
+ useQuery(() => ({ queryKey: key, queryFn: () => 'test' }))
// it should infer the result type from a generic query function
function queryFn(): Promise {
return Promise.resolve({} as T)
}
- const fromGenericQueryFn = createQuery(() => ({
+ const fromGenericQueryFn = useQuery(() => ({
queryKey: key,
queryFn: () => queryFn(),
}))
expectTypeOf(fromGenericQueryFn.data).toEqualTypeOf()
expectTypeOf(fromGenericQueryFn.error).toEqualTypeOf()
- const fromGenericOptionsQueryFn = createQuery(() => ({
+ const fromGenericOptionsQueryFn = useQuery(() => ({
queryKey: key,
queryFn: () => queryFn(),
}))
@@ -128,7 +123,7 @@ describe('createQuery', () => {
return n + 42
}
- createQuery(() => ({
+ useQuery(() => ({
queryKey: ['my-data', 100] as const,
queryFn: getMyDataArrayKey,
}))
@@ -140,13 +135,13 @@ describe('createQuery', () => {
return Number(context.queryKey[0]) + 42
}
- createQuery(() => ({
+ useQuery(() => ({
queryKey: ['1'] as ['1'],
queryFn: getMyDataStringKey,
}))
// it should handle query-functions that return Promise
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key,
queryFn: () => fetch('return Promise').then((resp) => resp.json()),
}))
@@ -165,12 +160,12 @@ describe('createQuery', () => {
// return type must be wrapped with TQueryFnReturn
) => Promise,
options?: OmitKeyof<
- CreateQueryOptions,
+ UseQueryOptions,
'queryKey' | 'queryFn' | 'initialData',
'safely'
>,
) =>
- createQuery(() => ({
+ useQuery(() => ({
queryKey: qk,
queryFn: () => fetcher(qk[1], 'token'),
...options,
@@ -178,7 +173,7 @@ describe('createQuery', () => {
const test = useWrappedQuery([''], async () => '1')
expectTypeOf(test.data).toEqualTypeOf()
- // handles wrapped queries with custom fetcher passed directly to createQuery
+ // handles wrapped queries with custom fetcher passed directly to useQuery
const useWrappedFuncStyleQuery = <
TQueryKey extends [string, Record?],
TQueryFnData,
@@ -188,11 +183,11 @@ describe('createQuery', () => {
qk: TQueryKey,
fetcher: () => Promise,
options?: OmitKeyof<
- CreateQueryOptions,
+ UseQueryOptions,
'queryKey' | 'queryFn' | 'initialData',
'safely'
>,
- ) => createQuery(() => ({ queryKey: qk, queryFn: fetcher, ...options }))
+ ) => useQuery(() => ({ queryKey: qk, queryFn: fetcher, ...options }))
const testFuncStyle = useWrappedFuncStyleQuery([''], async () => true)
expectTypeOf(testFuncStyle.data).toEqualTypeOf()
}
@@ -203,7 +198,7 @@ describe('createQuery', () => {
const key = queryKey()
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -231,10 +226,10 @@ describe('createQuery', () => {
it('should return the correct states for a successful query', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page(): JSX.Element {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -339,10 +334,10 @@ describe('createQuery', () => {
it('should return the correct states for an unsuccessful query', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => Promise.reject(new Error('rejected')),
retry: 1,
@@ -457,7 +452,7 @@ describe('createQuery', () => {
it('should set isFetchedAfterMount to true after a query has been fetched', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
await queryClient.prefetchQuery({
queryKey: key,
@@ -465,7 +460,7 @@ describe('createQuery', () => {
})
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => 'data',
}))
@@ -501,7 +496,7 @@ describe('createQuery', () => {
let fetchCount = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
fetchCount++
@@ -540,7 +535,7 @@ describe('createQuery', () => {
let fetchCount = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
fetchCount++
@@ -579,7 +574,7 @@ describe('createQuery', () => {
let fetchCount = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
fetchCount++
@@ -614,12 +609,12 @@ describe('createQuery', () => {
it('should be able to watch a query without providing a query function', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
queryClient.setQueryDefaults(key, { queryFn: () => 'data' })
function Page() {
- const state = createQuery(() => ({ queryKey: key }))
+ const state = useQuery(() => ({ queryKey: key }))
createRenderEffect(() => {
states.push({ ...state })
})
@@ -641,7 +636,7 @@ describe('createQuery', () => {
it('should pick up a query when re-mounting with gcTime 0', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
const [toggle, setToggle] = createSignal(false)
@@ -662,7 +657,7 @@ describe('createQuery', () => {
}
function Component({ value }: { value: string }) {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -721,10 +716,10 @@ describe('createQuery', () => {
it('should fetch when refetchOnMount is false and nothing has been fetched yet', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
refetchOnMount: false,
@@ -750,12 +745,12 @@ describe('createQuery', () => {
it('should not fetch when refetchOnMount is false and data has been fetched already', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
queryClient.setQueryData(key, 'prefetched')
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
refetchOnMount: false,
@@ -780,10 +775,10 @@ describe('createQuery', () => {
it('should be able to select a part of the data with select', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => ({ name: 'test' }),
select: (data) => data.name,
@@ -809,10 +804,10 @@ describe('createQuery', () => {
it('should be able to select a part of the data with select in object syntax 2', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => ({ name: 'test' }),
select: (data) => data.name,
@@ -838,10 +833,10 @@ describe('createQuery', () => {
it('should be able to select a part of the data with select in object syntax 1', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => ({ name: 'test' }),
select: (data) => data.name,
@@ -867,10 +862,10 @@ describe('createQuery', () => {
it('should not re-render when it should only re-render only data change and the selected data did not change', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -911,7 +906,7 @@ describe('createQuery', () => {
const error = new Error('Select Error')
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => ({ name: 'test' }),
select: () => {
@@ -943,10 +938,10 @@ describe('createQuery', () => {
it('should track properties and only re-render when a tracked property changes', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -991,10 +986,10 @@ describe('createQuery', () => {
it('should always re-render if we are tracking props but not using any', async () => {
const key = queryKey()
let renderCount = 0
- const states: Array> = []
+ const states: Array> = []
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: () => 'test',
}))
@@ -1044,12 +1039,12 @@ describe('createQuery', () => {
{ id: '2', done: true },
]
- const states: Array> = []
+ const states: Array> = []
let count = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1106,12 +1101,12 @@ describe('createQuery', () => {
it('should use query function from hook when the existing query does not have a query function', async () => {
const key = queryKey()
- const results: Array> = []
+ const results: Array> = []
queryClient.setQueryData(key, 'set')
function Page() {
- const result = createQuery(() => ({
+ const result = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1155,11 +1150,11 @@ describe('createQuery', () => {
it('should update query stale state and refetch when invalidated with invalidateQueries', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
let count = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1229,11 +1224,11 @@ describe('createQuery', () => {
it('should not update disabled query when refetch with refetchQueries', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
let count = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1275,11 +1270,11 @@ describe('createQuery', () => {
it('should not refetch disabled query when invalidated with invalidateQueries', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
let count = 0
function Page() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1321,12 +1316,12 @@ describe('createQuery', () => {
it('should not fetch when switching to a disabled query', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
const [count, setCount] = createSignal(0)
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: [key, count()],
queryFn: async () => {
await sleep(5)
@@ -1378,12 +1373,12 @@ describe('createQuery', () => {
it('should keep the previous data when placeholderData is set', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
const [count, setCount] = createSignal(0)
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: [key, count()],
queryFn: async () => {
await sleep(10)
@@ -1445,12 +1440,12 @@ describe('createQuery', () => {
it('should not show initial data from next query if placeholderData is set', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function Page() {
const [count, setCount] = createSignal(0)
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: [key, count()],
queryFn: async () => {
await sleep(10)
@@ -1525,7 +1520,7 @@ describe('createQuery', () => {
it('should keep the previous data on disabled query when placeholderData is set and switching query key multiple times', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
queryClient.setQueryData([key, 10], 10)
@@ -1534,7 +1529,7 @@ describe('createQuery', () => {
function Page() {
const [count, setCount] = createSignal(10)
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: [key, count()],
queryFn: async () => {
await sleep(10)
@@ -1607,10 +1602,10 @@ describe('createQuery', () => {
it('should use the correct query function when components use different configurations', async () => {
const key = queryKey()
- const states: Array> = []
+ const states: Array> = []
function FirstComponent() {
- const state = createQuery(() => ({
+ const state = useQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
@@ -1631,7 +1626,7 @@ describe('createQuery', () => {
}
function SecondComponent() {
- createQuery(() => ({
+ useQuery(() => ({
queryKey: key,
queryFn: () => 2,
}))
@@ -1675,8 +1670,8 @@ describe('createQuery', () => {
it('should be able to set different stale times for a query', async () => {
const key = queryKey()
- const states1: Array> = []
- const states2: Array> = []
+ const states1: Array