refactor: rename "FunctionedParams" utility type to "Accessor"

This change is more in line with solid.js's Accessor utility type and improves readability. The "Params" in FunctionedParams<T> is misleading since FunctionedParams<T> is already called invoked in the parameters of a function anyway
TanStack · Jan 10, 2025 · 32f7c6a · 32f7c6a
1 parent 56f67c7
commit 32f7c6a
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 18 deletions.
diff --git 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<TQueryFnData, TError, TData, TQueryData, TQueryKey>
   >,
   Observer: typeof QueryObserver,

diff --git 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
@@ -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<TData, TError, TVariables, TContext>
   >,
   queryClient?: QueryClient,

diff --git 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<T>]>
+    queries: Accessor<[...QueriesOptions<T>]>
     combine?: (result: QueriesResults<T>) => TCombinedResult
   },
   queryClient?: QueryClient,

diff --git 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<TQueryFnData, TError, TData, TQueryKey>
   >,
   queryClient?: QueryClient,
@@ -30,7 +30,7 @@ export function createQuery<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  options: FunctionedParams<
+  options: Accessor<
     UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
   >,
   queryClient?: QueryClient,
@@ -42,14 +42,14 @@ export function createQuery<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  options: FunctionedParams<
+  options: Accessor<
     CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>
   >,
   queryClient?: QueryClient,
 ): CreateQueryResult<TData, TError>
 
 export function createQuery(
-  options: FunctionedParams<CreateQueryOptions>,
+  options: Accessor<CreateQueryOptions>,
   queryClient?: QueryClient,
 ) {
   return createBaseQuery(options, QueryObserver, queryClient)

diff --git 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> = () => T
+export type Accessor<T> = () => T
 
 /** Options for createBaseQuery */
 export type CreateBaseQueryOptions<

diff --git 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<CreateQueryOptions<any>>

diff --git 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<CreateMutationOptions>
     errorMutationOpts: FunctionedParams<CreateMutationOptions>
     mutationStateOpts?: MutationStateOptions | undefined