@tanstack/solid-query 5.32.0 → 5.33.1

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 (5) hide show
  1. package/build/index.d.cts +34 -3
  2. package/build/index.d.ts +34 -3
  3. package/package.json +2 -2
  4. package/src/createQueries.ts +8 -1
  5. package/src/types.ts +28 -7
package/build/index.d.cts CHANGED
@@ -32,8 +32,20 @@ declare class QueryClient extends QueryClient$1 {
32
32
  }
33
33
 
34
34
  type FunctionedParams<T> = () => T;
35
- interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
35
+ interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
36
+ /**
37
+ * Only applicable while rendering queries on the server with streaming.
38
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
39
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
40
+ * Defaults to `false`.
41
+ */
36
42
  deferStream?: boolean;
43
+ /**
44
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
45
+ * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
46
+ * Setting `suspense` to `false` will be a no-op.
47
+ */
48
+ suspense?: boolean;
37
49
  }
38
50
  interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
39
51
  }
@@ -42,9 +54,21 @@ type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserv
42
54
  type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
43
55
  type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
44
56
  type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
45
- interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey'> {
57
+ interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey' | 'suspense'> {
46
58
  queryKey: TQueryKey;
59
+ /**
60
+ * Only applicable while rendering queries on the server with streaming.
61
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
62
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
63
+ * Defaults to `false`.
64
+ */
47
65
  deferStream?: boolean;
66
+ /**
67
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
68
+ * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
69
+ * Setting `suspense` to `false` will be a no-op.
70
+ */
71
+ suspense?: boolean;
48
72
  }
49
73
  type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FunctionedParams<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
50
74
  type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
@@ -96,8 +120,15 @@ type MutationStateOptions<TResult = MutationState> = {
96
120
  };
97
121
  declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
98
122
 
99
- type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData'> & {
123
+ type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
100
124
  placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
125
+ /**
126
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
127
+ * The `data` property on createQueries is a plain object and not a SolidJS Resource.
128
+ * It will not suspend when the data is loading.
129
+ * Setting `suspense` to `true` will be a no-op.
130
+ */
131
+ suspense?: boolean;
101
132
  };
102
133
  type MAXIMUM_DEPTH = 20;
103
134
  type GetOptions<T> = T extends {
package/build/index.d.ts CHANGED
@@ -32,8 +32,20 @@ declare class QueryClient extends QueryClient$1 {
32
32
  }
33
33
 
34
34
  type FunctionedParams<T> = () => T;
35
- interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
35
+ interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
36
+ /**
37
+ * Only applicable while rendering queries on the server with streaming.
38
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
39
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
40
+ * Defaults to `false`.
41
+ */
36
42
  deferStream?: boolean;
43
+ /**
44
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
45
+ * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
46
+ * Setting `suspense` to `false` will be a no-op.
47
+ */
48
+ suspense?: boolean;
37
49
  }
38
50
  interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
39
51
  }
@@ -42,9 +54,21 @@ type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserv
42
54
  type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
43
55
  type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
44
56
  type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
45
- interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey'> {
57
+ interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey' | 'suspense'> {
46
58
  queryKey: TQueryKey;
59
+ /**
60
+ * Only applicable while rendering queries on the server with streaming.
61
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
62
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
63
+ * Defaults to `false`.
64
+ */
47
65
  deferStream?: boolean;
66
+ /**
67
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
68
+ * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
69
+ * Setting `suspense` to `false` will be a no-op.
70
+ */
71
+ suspense?: boolean;
48
72
  }
49
73
  type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FunctionedParams<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
50
74
  type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
@@ -96,8 +120,15 @@ type MutationStateOptions<TResult = MutationState> = {
96
120
  };
97
121
  declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
98
122
 
99
- type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData'> & {
123
+ type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
100
124
  placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
125
+ /**
126
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
127
+ * The `data` property on createQueries is a plain object and not a SolidJS Resource.
128
+ * It will not suspend when the data is loading.
129
+ * Setting `suspense` to `true` will be a no-op.
130
+ */
131
+ suspense?: boolean;
101
132
  };
102
133
  type MAXIMUM_DEPTH = 20;
103
134
  type GetOptions<T> = T extends {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/solid-query",
3
- "version": "5.32.0",
3
+ "version": "5.33.1",
4
4
  "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -45,7 +45,7 @@
45
45
  ],
46
46
  "dependencies": {
47
47
  "solid-js": "^1.8.14",
48
- "@tanstack/query-core": "5.32.0"
48
+ "@tanstack/query-core": "5.32.1"
49
49
  },
50
50
  "devDependencies": {
51
51
  "tsup-preset-solid": "^2.2.0",
package/src/createQueries.ts CHANGED
@@ -37,9 +37,16 @@ type CreateQueryOptionsForCreateQueries<
37
37
  TQueryKey extends QueryKey = QueryKey,
38
38
  > = OmitKeyof<
39
39
  SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
40
- 'placeholderData'
40
+ 'placeholderData' | 'suspense'
41
41
  > & {
42
42
  placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>
43
+ /**
44
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
45
+ * The `data` property on createQueries is a plain object and not a SolidJS Resource.
46
+ * It will not suspend when the data is loading.
47
+ * Setting `suspense` to `true` will be a no-op.
48
+ */
49
+ suspense?: boolean
43
50
  }
44
51
 
45
52
  // Avoid TS depth-limit error in case of large array literal
package/src/types.ts CHANGED
@@ -24,14 +24,23 @@ export interface CreateBaseQueryOptions<
24
24
  TData = TQueryFnData,
25
25
  TQueryData = TQueryFnData,
26
26
  TQueryKey extends QueryKey = QueryKey,
27
- > extends QueryObserverOptions<
28
- TQueryFnData,
29
- TError,
30
- TData,
31
- TQueryData,
32
- TQueryKey
27
+ > extends OmitKeyof<
28
+ QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
29
+ 'suspense'
33
30
  > {
31
+ /**
32
+ * Only applicable while rendering queries on the server with streaming.
33
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
34
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
35
+ * Defaults to `false`.
36
+ */
34
37
  deferStream?: boolean
38
+ /**
39
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
40
+ * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
41
+ * Setting `suspense` to `false` will be a no-op.
42
+ */
43
+ suspense?: boolean
35
44
  }
36
45
 
37
46
  export interface SolidQueryOptions<
@@ -93,10 +102,22 @@ export interface SolidInfiniteQueryOptions<
93
102
  TQueryKey,
94
103
  TPageParam
95
104
  >,
96
- 'queryKey'
105
+ 'queryKey' | 'suspense'
97
106
  > {
98
107
  queryKey: TQueryKey
108
+ /**
109
+ * Only applicable while rendering queries on the server with streaming.
110
+ * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
111
+ * This can be useful to avoid sending a loading state to the client before the query has resolved.
112
+ * Defaults to `false`.
113
+ */
99
114
  deferStream?: boolean
115
+ /**
116
+ * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
117
+ * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
118
+ * Setting `suspense` to `false` will be a no-op.
119
+ */
120
+ suspense?: boolean
100
121
  }
101
122
 
102
123
  export type CreateInfiniteQueryOptions<