@tanstack/svelte-query 4.22.1 → 4.22.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/build/lib/createBaseQuery.d.ts +2 -4
  2. package/build/lib/createMutation.d.ts +5 -5
  3. package/build/lib/createQuery.d.ts +7 -7
  4. package/build/lib/types.d.ts +10 -13
  5. package/package.json +3 -3
  6. package/src/__tests__/CreateMutation.svelte +5 -3
  7. package/src/__tests__/createMutation.test.ts +3 -3
  8. package/src/createBaseQuery.ts +2 -2
  9. package/src/createMutation.ts +13 -13
  10. package/src/createQuery.ts +8 -8
  11. package/src/types.ts +17 -36
package/build/lib/createBaseQuery.d.ts CHANGED
@@ -1,5 +1,3 @@
1
1
  import { type QueryKey, type QueryObserver } from '@tanstack/query-core';
2
- import type { CreateBaseQueryOptions } from './types';
3
- export declare function createBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, Observer: typeof QueryObserver): {
4
- subscribe: (this: void, run: import("svelte/store").Subscriber<import("@tanstack/query-core").QueryObserverResult<TData, TError>>, invalidate?: ((value?: import("@tanstack/query-core").QueryObserverResult<TData, TError> | undefined) => void) | undefined) => import("svelte/store").Unsubscriber;
5
- };
2
+ import type { CreateBaseQueryOptions, CreateBaseQueryResult } from './types';
3
+ export declare function createBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, Observer: typeof QueryObserver): CreateBaseQueryResult<TData, TError>;
package/build/lib/createMutation.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { type MutationFunction, type MutationKey } from '@tanstack/query-core';
2
- import type { CreateMutationOptions, MutationStoreResult } from './types';
3
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>): MutationStoreResult<TData, TError, TVariables, TContext>;
4
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): MutationStoreResult<TData, TError, TVariables, TContext>;
5
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationKey: MutationKey, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): MutationStoreResult<TData, TError, TVariables, TContext>;
6
- export declare function createMutation<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): MutationStoreResult<TData, TError, TVariables, TContext>;
2
+ import type { CreateMutationOptions, CreateMutationResult } from './types';
3
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>): CreateMutationResult<TData, TError, TVariables, TContext>;
4
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
5
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): CreateMutationResult<TData, TError, TVariables, TContext>;
6
+ export declare function createMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<CreateMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): CreateMutationResult<TData, TError, TVariables, TContext>;
package/build/lib/createQuery.d.ts CHANGED
@@ -1,23 +1,23 @@
1
1
  import type { QueryFunction, QueryKey } from '@tanstack/query-core';
2
- import type { DefinedCreateQueryResult, CreateQueryOptions, CreateQueryStoreResult } from './types';
2
+ import type { DefinedCreateQueryResult, CreateQueryOptions, CreateQueryResult } from './types';
3
3
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
4
4
  initialData?: () => undefined;
5
- }): CreateQueryStoreResult<TData, TError>;
5
+ }): CreateQueryResult<TData, TError>;
6
6
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
7
7
  initialData: TQueryFnData | (() => TQueryFnData);
8
8
  }): DefinedCreateQueryResult<TData, TError>;
9
- export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryStoreResult<TData, TError>;
9
+ export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryResult<TData, TError>;
10
10
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
11
11
  initialData?: () => undefined;
12
- }): CreateQueryStoreResult<TData, TError>;
12
+ }): CreateQueryResult<TData, TError>;
13
13
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
14
14
  initialData: TQueryFnData | (() => TQueryFnData);
15
15
  }): DefinedCreateQueryResult<TData, TError>;
16
- export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>): CreateQueryStoreResult<TData, TError>;
16
+ export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>): CreateQueryResult<TData, TError>;
17
17
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
18
18
  initialData?: () => undefined;
19
- }): CreateQueryStoreResult<TData, TError>;
19
+ }): CreateQueryResult<TData, TError>;
20
20
  export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
21
21
  initialData: TQueryFnData | (() => TQueryFnData);
22
22
  }): DefinedCreateQueryResult<TData, TError>;
23
- export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>): CreateQueryStoreResult<TData, TError>;
23
+ export declare function createQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>): CreateQueryResult<TData, TError>;
package/build/lib/types.d.ts CHANGED
@@ -9,30 +9,27 @@ export interface ContextOptions {
9
9
  }
10
10
  export interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
11
11
  }
12
+ export interface CreateBaseQueryResult<TData = unknown, TError = unknown> extends Readable<QueryObserverResult<TData, TError>> {
13
+ }
12
14
  export interface CreateQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
13
15
  }
16
+ export interface CreateQueryResult<TData = unknown, TError = unknown> extends CreateBaseQueryResult<TData, TError> {
17
+ }
14
18
  export interface CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
15
19
  }
16
20
  export declare type CreateInfiniteQueryResult<TData = unknown, TError = unknown> = Readable<InfiniteQueryObserverResult<TData, TError>>;
17
- export interface CreateInfiniteQueryStoreResult<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData> extends Readable<CreateInfiniteQueryResult<TData, TError>> {
18
- }
19
- export declare type CreateBaseQueryResult<TData = unknown, TError = unknown> = QueryObserverResult<TData, TError>;
20
- export declare type CreateQueryResult<TData = unknown, TError = unknown> = CreateBaseQueryResult<TData, TError>;
21
- export interface CreateQueryStoreResult<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData> extends Readable<CreateQueryResult<TData, TError>> {
22
- }
23
21
  export declare type DefinedCreateBaseQueryResult<TData = unknown, TError = unknown> = Readable<DefinedQueryObserverResult<TData, TError>>;
24
22
  export declare type DefinedCreateQueryResult<TData = unknown, TError = unknown> = DefinedCreateBaseQueryResult<TData, TError>;
25
23
  export interface CreateMutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends ContextOptions, Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'> {
26
24
  }
27
- export declare type UseMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
28
- export declare type UseMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
29
- export declare type UseBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
30
- mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
25
+ export declare type CreateMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
26
+ export declare type CreateMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
27
+ export declare type CreateBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
28
+ mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
31
29
  }> & {
32
- mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
30
+ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
33
31
  };
34
- export declare type CreateMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
35
- export interface MutationStoreResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> extends Readable<CreateMutationResult<TData, TError, TVariables, TContext>> {
32
+ export interface CreateMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> extends Readable<CreateBaseMutationResult<TData, TError, TVariables, TContext>> {
36
33
  }
37
34
  declare type Override<A, B> = {
38
35
  [K in keyof A]: K extends keyof B ? B[K] : A[K];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/svelte-query",
3
- "version": "4.22.1",
3
+ "version": "4.22.3",
4
4
  "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
5
5
  "author": "Dre Johnson",
6
6
  "license": "MIT",
@@ -17,7 +17,7 @@
17
17
  "@sveltejs/package": "^1.0.0",
18
18
  "@sveltejs/vite-plugin-svelte": "^2.0.2",
19
19
  "@testing-library/svelte": "^3.2.2",
20
- "@vitest/coverage-istanbul": "^0.26.3",
20
+ "@vitest/coverage-istanbul": "^0.27.1",
21
21
  "eslint-plugin-svelte": "^2.14.1",
22
22
  "jsdom": "^20.0.3",
23
23
  "svelte": "^3.54.0",
@@ -25,7 +25,7 @@
25
25
  "tslib": "^2.4.1",
26
26
  "typescript": "^4.7.4",
27
27
  "vite": "^4.0.0",
28
- "vitest": "^0.26.3"
28
+ "vitest": "^0.27.1"
29
29
  },
30
30
  "dependencies": {
31
31
  "@tanstack/query-core": "4.22.0"
package/src/__tests__/CreateMutation.svelte CHANGED
@@ -2,12 +2,14 @@
2
2
  import { createMutation, QueryClient } from '../index'
3
3
  import { setQueryClientContext } from '../context'
4
4
 
5
- export let queryFn: () => Promise<string>
5
+ export let mutationFn: () => Promise<string>
6
6
 
7
7
  const queryClient = new QueryClient()
8
8
  setQueryClientContext(queryClient)
9
9
 
10
- const mutation = createMutation(queryFn)
10
+ const mutation = createMutation({
11
+ mutationFn,
12
+ })
11
13
  </script>
12
14
 
13
- <button on:click={$mutation.mutate}>Click</button>
15
+ <button on:click={() => $mutation.mutate()}>Click</button>
package/src/__tests__/createMutation.test.ts CHANGED
@@ -5,11 +5,11 @@ import { sleep } from './utils'
5
5
 
6
6
  describe('createMutation', () => {
7
7
  it('Call mutate and check function runs', async () => {
8
- const queryFn = vi.fn()
8
+ const mutationFn = vi.fn()
9
9
 
10
10
  render(CreateMutation, {
11
11
  props: {
12
- queryFn,
12
+ mutationFn,
13
13
  },
14
14
  })
15
15
 
@@ -17,6 +17,6 @@ describe('createMutation', () => {
17
17
 
18
18
  await sleep(200)
19
19
 
20
- expect(queryFn).toHaveBeenCalledTimes(1)
20
+ expect(mutationFn).toHaveBeenCalledTimes(1)
21
21
  })
22
22
  })
package/src/createBaseQuery.ts CHANGED
@@ -3,7 +3,7 @@ import {
3
3
  type QueryKey,
4
4
  type QueryObserver,
5
5
  } from '@tanstack/query-core'
6
- import type { CreateBaseQueryOptions } from './types'
6
+ import type { CreateBaseQueryOptions, CreateBaseQueryResult } from './types'
7
7
  import { useQueryClient } from './useQueryClient'
8
8
  import { derived, readable } from 'svelte/store'
9
9
 
@@ -22,7 +22,7 @@ export function createBaseQuery<
22
22
  TQueryKey
23
23
  >,
24
24
  Observer: typeof QueryObserver,
25
- ) {
25
+ ): CreateBaseQueryResult<TData, TError> {
26
26
  const queryClient = useQueryClient()
27
27
  const defaultedOptions = queryClient.defaultQueryOptions(options)
28
28
  defaultedOptions._optimisticResults = 'optimistic'
package/src/createMutation.ts CHANGED
@@ -7,25 +7,25 @@ import {
7
7
  parseMutationArgs,
8
8
  } from '@tanstack/query-core'
9
9
  import type {
10
- UseMutateFunction,
10
+ CreateMutateFunction,
11
11
  CreateMutationOptions,
12
- MutationStoreResult,
12
+ CreateMutationResult,
13
13
  } from './types'
14
14
  import { useQueryClient } from './useQueryClient'
15
15
 
16
16
  export function createMutation<
17
17
  TData = unknown,
18
18
  TError = unknown,
19
- TVariables = unknown,
19
+ TVariables = void,
20
20
  TContext = unknown,
21
21
  >(
22
22
  options: CreateMutationOptions<TData, TError, TVariables, TContext>,
23
- ): MutationStoreResult<TData, TError, TVariables, TContext>
23
+ ): CreateMutationResult<TData, TError, TVariables, TContext>
24
24
 
25
25
  export function createMutation<
26
26
  TData = unknown,
27
27
  TError = unknown,
28
- TVariables = unknown,
28
+ TVariables = void,
29
29
  TContext = unknown,
30
30
  >(
31
31
  mutationFn: MutationFunction<TData, TVariables>,
@@ -33,12 +33,12 @@ export function createMutation<
33
33
  CreateMutationOptions<TData, TError, TVariables, TContext>,
34
34
  'mutationFn'
35
35
  >,
36
- ): MutationStoreResult<TData, TError, TVariables, TContext>
36
+ ): CreateMutationResult<TData, TError, TVariables, TContext>
37
37
 
38
38
  export function createMutation<
39
39
  TData = unknown,
40
40
  TError = unknown,
41
- TVariables = unknown,
41
+ TVariables = void,
42
42
  TContext = unknown,
43
43
  >(
44
44
  mutationKey: MutationKey,
@@ -46,12 +46,12 @@ export function createMutation<
46
46
  CreateMutationOptions<TData, TError, TVariables, TContext>,
47
47
  'mutationKey'
48
48
  >,
49
- ): MutationStoreResult<TData, TError, TVariables, TContext>
49
+ ): CreateMutationResult<TData, TError, TVariables, TContext>
50
50
 
51
51
  export function createMutation<
52
52
  TData = unknown,
53
53
  TError = unknown,
54
- TVariables = unknown,
54
+ TVariables = void,
55
55
  TContext = unknown,
56
56
  >(
57
57
  mutationKey: MutationKey,
@@ -60,12 +60,12 @@ export function createMutation<
60
60
  CreateMutationOptions<TData, TError, TVariables, TContext>,
61
61
  'mutationKey' | 'mutationFn'
62
62
  >,
63
- ): MutationStoreResult<TData, TError, TVariables, TContext>
63
+ ): CreateMutationResult<TData, TError, TVariables, TContext>
64
64
 
65
65
  export function createMutation<
66
66
  TData = unknown,
67
67
  TError = unknown,
68
- TVariables = unknown,
68
+ TVariables = void,
69
69
  TContext = unknown,
70
70
  >(
71
71
  arg1:
@@ -76,14 +76,14 @@ export function createMutation<
76
76
  | MutationFunction<TData, TVariables>
77
77
  | CreateMutationOptions<TData, TError, TVariables, TContext>,
78
78
  arg3?: CreateMutationOptions<TData, TError, TVariables, TContext>,
79
- ): MutationStoreResult<TData, TError, TVariables, TContext> {
79
+ ): CreateMutationResult<TData, TError, TVariables, TContext> {
80
80
  const options = parseMutationArgs(arg1, arg2, arg3)
81
81
  const queryClient = useQueryClient()
82
82
  let observer = new MutationObserver<TData, TError, TVariables, TContext>(
83
83
  queryClient,
84
84
  options,
85
85
  )
86
- let mutate: UseMutateFunction<TData, TError, TVariables, TContext>
86
+ let mutate: CreateMutateFunction<TData, TError, TVariables, TContext>
87
87
 
88
88
  readable(observer).subscribe(($observer) => {
89
89
  observer = $observer
package/src/createQuery.ts CHANGED
@@ -4,7 +4,7 @@ import { createBaseQuery } from './createBaseQuery'
4
4
  import type {
5
5
  DefinedCreateQueryResult,
6
6
  CreateQueryOptions,
7
- CreateQueryStoreResult,
7
+ CreateQueryResult,
8
8
  } from './types'
9
9
 
10
10
  export function createQuery<
@@ -19,7 +19,7 @@ export function createQuery<
19
19
  > & {
20
20
  initialData?: () => undefined
21
21
  },
22
- ): CreateQueryStoreResult<TData, TError>
22
+ ): CreateQueryResult<TData, TError>
23
23
 
24
24
  export function createQuery<
25
25
  TQueryFnData = unknown,
@@ -42,7 +42,7 @@ export function createQuery<
42
42
  TQueryKey extends QueryKey = QueryKey,
43
43
  >(
44
44
  options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
45
- ): CreateQueryStoreResult<TData, TError>
45
+ ): CreateQueryResult<TData, TError>
46
46
 
47
47
  export function createQuery<
48
48
  TQueryFnData = unknown,
@@ -55,7 +55,7 @@ export function createQuery<
55
55
  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
56
56
  'queryKey' | 'initialData'
57
57
  > & { initialData?: () => undefined },
58
- ): CreateQueryStoreResult<TData, TError>
58
+ ): CreateQueryResult<TData, TError>
59
59
 
60
60
  export function createQuery<
61
61
  TQueryFnData = unknown,
@@ -81,7 +81,7 @@ export function createQuery<
81
81
  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
82
82
  'queryKey'
83
83
  >,
84
- ): CreateQueryStoreResult<TData, TError>
84
+ ): CreateQueryResult<TData, TError>
85
85
 
86
86
  export function createQuery<
87
87
  TQueryFnData = unknown,
@@ -95,7 +95,7 @@ export function createQuery<
95
95
  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
96
96
  'queryKey' | 'queryFn' | 'initialData'
97
97
  > & { initialData?: () => undefined },
98
- ): CreateQueryStoreResult<TData, TError>
98
+ ): CreateQueryResult<TData, TError>
99
99
 
100
100
  export function createQuery<
101
101
  TQueryFnData = unknown,
@@ -123,7 +123,7 @@ export function createQuery<
123
123
  CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
124
124
  'queryKey' | 'queryFn'
125
125
  >,
126
- ): CreateQueryStoreResult<TData, TError>
126
+ ): CreateQueryResult<TData, TError>
127
127
 
128
128
  export function createQuery<
129
129
  TQueryFnData,
@@ -136,7 +136,7 @@ export function createQuery<
136
136
  | QueryFunction<TQueryFnData, TQueryKey>
137
137
  | CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
138
138
  arg3?: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
139
- ): CreateQueryStoreResult<TData, TError> {
139
+ ): CreateQueryResult<TData, TError> {
140
140
  const parsedOptions = parseQueryArgs(arg1, arg2, arg3)
141
141
  const result = createBaseQuery(parsedOptions, QueryObserver)
142
142
  return result
package/src/types.ts CHANGED
@@ -28,6 +28,9 @@ export interface CreateBaseQueryOptions<
28
28
  > extends ContextOptions,
29
29
  QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {}
30
30
 
31
+ export interface CreateBaseQueryResult<TData = unknown, TError = unknown>
32
+ extends Readable<QueryObserverResult<TData, TError>> {}
33
+
31
34
  export interface CreateQueryOptions<
32
35
  TQueryFnData = unknown,
33
36
  TError = unknown,
@@ -41,6 +44,9 @@ export interface CreateQueryOptions<
41
44
  TQueryKey
42
45
  > {}
43
46
 
47
+ export interface CreateQueryResult<TData = unknown, TError = unknown>
48
+ extends CreateBaseQueryResult<TData, TError> {}
49
+
44
50
  export interface CreateInfiniteQueryOptions<
45
51
  TQueryFnData = unknown,
46
52
  TError = unknown,
@@ -60,28 +66,6 @@ export type CreateInfiniteQueryResult<
60
66
  TError = unknown,
61
67
  > = Readable<InfiniteQueryObserverResult<TData, TError>>
62
68
 
63
- export interface CreateInfiniteQueryStoreResult<
64
- TQueryFnData = unknown,
65
- TError = unknown,
66
- TData = TQueryFnData,
67
- > extends Readable<CreateInfiniteQueryResult<TData, TError>> {}
68
-
69
- export type CreateBaseQueryResult<
70
- TData = unknown,
71
- TError = unknown,
72
- > = QueryObserverResult<TData, TError>
73
-
74
- export type CreateQueryResult<
75
- TData = unknown,
76
- TError = unknown,
77
- > = CreateBaseQueryResult<TData, TError>
78
-
79
- export interface CreateQueryStoreResult<
80
- TQueryFnData = unknown,
81
- TError = unknown,
82
- TData = TQueryFnData,
83
- > extends Readable<CreateQueryResult<TData, TError>> {}
84
-
85
69
  export type DefinedCreateBaseQueryResult<
86
70
  TData = unknown,
87
71
  TError = unknown,
@@ -103,7 +87,7 @@ export interface CreateMutationOptions<
103
87
  '_defaulted' | 'variables'
104
88
  > {}
105
89
 
106
- export type UseMutateFunction<
90
+ export type CreateMutateFunction<
107
91
  TData = unknown,
108
92
  TError = unknown,
109
93
  TVariables = void,
@@ -112,35 +96,32 @@ export type UseMutateFunction<
112
96
  ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
113
97
  ) => void
114
98
 
115
- export type UseMutateAsyncFunction<
99
+ export type CreateMutateAsyncFunction<
116
100
  TData = unknown,
117
101
  TError = unknown,
118
102
  TVariables = void,
119
103
  TContext = unknown,
120
104
  > = MutateFunction<TData, TError, TVariables, TContext>
121
105
 
122
- export type UseBaseMutationResult<
106
+ export type CreateBaseMutationResult<
123
107
  TData = unknown,
124
108
  TError = unknown,
125
109
  TVariables = unknown,
126
110
  TContext = unknown,
127
111
  > = Override<
128
112
  MutationObserverResult<TData, TError, TVariables, TContext>,
129
- { mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
130
- > & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
131
-
132
- export type CreateMutationResult<
133
- TData = unknown,
134
- TError = unknown,
135
- TVariables = unknown,
136
- TContext = unknown,
137
- > = UseBaseMutationResult<TData, TError, TVariables, TContext>
113
+ { mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
114
+ > & {
115
+ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
116
+ }
138
117
 
139
- export interface MutationStoreResult<
118
+ export interface CreateMutationResult<
140
119
  TData = unknown,
141
120
  TError = unknown,
142
121
  TVariables = unknown,
143
122
  TContext = unknown,
144
- > extends Readable<CreateMutationResult<TData, TError, TVariables, TContext>> {}
123
+ > extends Readable<
124
+ CreateBaseMutationResult<TData, TError, TVariables, TContext>
125
+ > {}
145
126
 
146
127
  type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }