diff --git a/packages/svelte-query/src/context.ts b/packages/svelte-query/src/context.ts index 0676181f57..ec3dcda466 100644 --- a/packages/svelte-query/src/context.ts +++ b/packages/svelte-query/src/context.ts @@ -1,5 +1,6 @@ import { getContext, setContext } from 'svelte' import type { QueryClient } from '@tanstack/query-core' +import type { Accessor } from './types.js' const _contextKey = '$$_queryClient' @@ -23,9 +24,9 @@ export const setQueryClientContext = (client: QueryClient): void => { const _isRestoringContextKey = '$$_isRestoring' /** Retrieves a `isRestoring` from Svelte's context */ -export const getIsRestoringContext = (): (() => boolean) => { +export const getIsRestoringContext = (): Accessor => { try { - const isRestoring = getContext<(() => boolean) | undefined>( + const isRestoring = getContext<(Accessor) | undefined>( _isRestoringContextKey, ) return isRestoring ?? (() => false) @@ -35,6 +36,6 @@ export const getIsRestoringContext = (): (() => boolean) => { } /** Sets a `isRestoring` on Svelte's context */ -export const setIsRestoringContext = (isRestoring: () => boolean): void => { +export const setIsRestoringContext = (isRestoring: Accessor): void => { setContext(_isRestoringContextKey, isRestoring) } diff --git a/packages/svelte-query/src/createBaseQuery.svelte.ts b/packages/svelte-query/src/createBaseQuery.svelte.ts index 6290ea9b97..0743edab87 100644 --- a/packages/svelte-query/src/createBaseQuery.svelte.ts +++ b/packages/svelte-query/src/createBaseQuery.svelte.ts @@ -4,7 +4,7 @@ import { useQueryClient } from './useQueryClient.js' import type { CreateBaseQueryOptions, CreateBaseQueryResult, - FunctionedParams, + Accessor, } from './types.js' import type { QueryClient, @@ -20,7 +20,7 @@ export function createBaseQuery< TQueryData, TQueryKey extends QueryKey, >( - options: FunctionedParams< + options: Accessor< CreateBaseQueryOptions >, Observer: typeof QueryObserver, diff --git a/packages/svelte-query/src/createInfiniteQuery.ts b/packages/svelte-query/src/createInfiniteQuery.ts index b12d556fa3..c236afb263 100644 --- a/packages/svelte-query/src/createInfiniteQuery.ts +++ b/packages/svelte-query/src/createInfiniteQuery.ts @@ -10,7 +10,7 @@ import type { import type { CreateInfiniteQueryOptions, CreateInfiniteQueryResult, - FunctionedParams, + Accessor, } from './types.js' export function createInfiniteQuery< @@ -20,7 +20,7 @@ export function createInfiniteQuery< TQueryKey extends QueryKey = QueryKey, TPageParam = unknown, >( - options: FunctionedParams< + options: Accessor< CreateInfiniteQueryOptions< TQueryFnData, TError, diff --git a/packages/svelte-query/src/createMutation.svelte.ts b/packages/svelte-query/src/createMutation.svelte.ts index 3f0dfcecc3..aa601bf680 100644 --- a/packages/svelte-query/src/createMutation.svelte.ts +++ b/packages/svelte-query/src/createMutation.svelte.ts @@ -6,7 +6,7 @@ import type { CreateMutateFunction, CreateMutationOptions, CreateMutationResult, - FunctionedParams, + Accessor, } from './types.js' import type { DefaultError, QueryClient } from '@tanstack/query-core' @@ -17,7 +17,7 @@ export function createMutation< TVariables = void, TContext = unknown, >( - options: FunctionedParams< + options: Accessor< CreateMutationOptions >, queryClient?: QueryClient, diff --git a/packages/svelte-query/src/createQueries.svelte.ts b/packages/svelte-query/src/createQueries.svelte.ts index f5078e7b1b..76a8863508 100644 --- a/packages/svelte-query/src/createQueries.svelte.ts +++ b/packages/svelte-query/src/createQueries.svelte.ts @@ -2,7 +2,7 @@ import { untrack } from 'svelte' import { QueriesObserver, notifyManager } from '@tanstack/query-core' import { useIsRestoring } from './useIsRestoring.js' import { useQueryClient } from './useQueryClient.js' -import type { FunctionedParams } from './types.js' +import type { Accessor } from './types.js' import type { DefaultError, DefinedQueryObserverResult, @@ -208,7 +208,7 @@ export function createQueries< queries, ...options }: { - queries: FunctionedParams<[...QueriesOptions]> + queries: Accessor<[...QueriesOptions]> combine?: (result: QueriesResults) => TCombinedResult }, queryClient?: QueryClient, diff --git a/packages/svelte-query/src/createQuery.ts b/packages/svelte-query/src/createQuery.ts index 79b6782b2f..159c2f9b94 100644 --- a/packages/svelte-query/src/createQuery.ts +++ b/packages/svelte-query/src/createQuery.ts @@ -5,7 +5,7 @@ import type { CreateQueryOptions, CreateQueryResult, DefinedCreateQueryResult, - FunctionedParams, + Accessor, } from './types.js' import type { DefinedInitialDataOptions, @@ -18,7 +18,7 @@ export function createQuery< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( - options: FunctionedParams< + options: Accessor< DefinedInitialDataOptions >, queryClient?: QueryClient, @@ -30,7 +30,7 @@ export function createQuery< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( - options: FunctionedParams< + options: Accessor< UndefinedInitialDataOptions >, queryClient?: QueryClient, @@ -42,14 +42,14 @@ export function createQuery< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( - options: FunctionedParams< + options: Accessor< CreateQueryOptions >, queryClient?: QueryClient, ): CreateQueryResult export function createQuery( - options: FunctionedParams, + options: Accessor, queryClient?: QueryClient, ) { return createBaseQuery(options, QueryObserver, queryClient) diff --git a/packages/svelte-query/src/types.ts b/packages/svelte-query/src/types.ts index 05116a8786..1c6cc4d20e 100644 --- a/packages/svelte-query/src/types.ts +++ b/packages/svelte-query/src/types.ts @@ -17,7 +17,7 @@ import type { QueryObserverResult, } from '@tanstack/query-core' -export type FunctionedParams = () => T +export type Accessor = () => T /** Options for createBaseQuery */ export type CreateBaseQueryOptions< diff --git a/packages/svelte-query/src/useIsFetching.svelte.ts b/packages/svelte-query/src/useIsFetching.svelte.ts index 2296301a28..c29eca3225 100644 --- a/packages/svelte-query/src/useIsFetching.svelte.ts +++ b/packages/svelte-query/src/useIsFetching.svelte.ts @@ -1,11 +1,12 @@ import { onDestroy } from 'svelte' import { useQueryClient } from './useQueryClient.js' import type { QueryClient, QueryFilters } from '@tanstack/query-core' +import type { Accessor } from './types.js' export function useIsFetching( filters?: QueryFilters, queryClient?: QueryClient, -): () => number { +): Accessor { const client = useQueryClient(queryClient) const queryCache = client.getQueryCache() diff --git a/packages/svelte-query/src/useIsMutating.svelte.ts b/packages/svelte-query/src/useIsMutating.svelte.ts index 5e7992a93a..f3e5611603 100644 --- a/packages/svelte-query/src/useIsMutating.svelte.ts +++ b/packages/svelte-query/src/useIsMutating.svelte.ts @@ -1,11 +1,12 @@ import { notifyManager } from '@tanstack/query-core' import { useQueryClient } from './useQueryClient.js' import type { MutationFilters, QueryClient } from '@tanstack/query-core' +import type { Accessor } from './types.js' export function useIsMutating( filters?: MutationFilters, queryClient?: QueryClient, -): () => number { +): Accessor { const client = useQueryClient(queryClient) const cache = client.getMutationCache() // isMutating is the prev value initialized on mount * diff --git a/packages/svelte-query/src/useIsRestoring.ts b/packages/svelte-query/src/useIsRestoring.ts index f6ee9bb564..b67b60967e 100644 --- a/packages/svelte-query/src/useIsRestoring.ts +++ b/packages/svelte-query/src/useIsRestoring.ts @@ -1,5 +1,6 @@ import { getIsRestoringContext } from './context.js' +import type { Accessor } from './types.js' -export function useIsRestoring(): () => boolean { +export function useIsRestoring(): Accessor { return getIsRestoringContext() } diff --git a/packages/svelte-query/tests/createQuery/BaseExample.svelte b/packages/svelte-query/tests/createQuery/BaseExample.svelte index 030b205e57..e9b7bc45a3 100644 --- a/packages/svelte-query/tests/createQuery/BaseExample.svelte +++ b/packages/svelte-query/tests/createQuery/BaseExample.svelte @@ -3,10 +3,10 @@ import { createQuery } from '../../src/index.js' import type { QueryClient, QueryObserverResult } from '@tanstack/query-core' import type { CreateQueryOptions, FunctionedParams } from '../../src/index.js' - +Accessor let { options, - queryClient, + queryClient,Accessor states, }: { options: FunctionedParams> diff --git a/packages/svelte-query/tests/useMutationState/BaseExample.svelte b/packages/svelte-query/tests/useMutationState/BaseExample.svelte index b65cd41371..952db8ad39 100644 --- a/packages/svelte-query/tests/useMutationState/BaseExample.svelte +++ b/packages/svelte-query/tests/useMutationState/BaseExample.svelte @@ -6,14 +6,15 @@ import type { CreateMutationOptions, FunctionedParams, - MutationStateOptions, + AccessorteOptions, } from '../../src/index.js' let { successMutationOpts, errorMutationOpts, - mutationStateOpts, + mutationAccessor, }: { + Accessor successMutationOpts: FunctionedParams errorMutationOpts: FunctionedParams mutationStateOpts?: MutationStateOptions | undefined