@tanstack/solid-query - npm Package Compare versions

Comparing version 5.32.1 to 5.33.1

build/index.d.ts

@@ -35,4 +35,16 @@ import { DefaultError, QueryKey, OmitKeyof, QueryObserverOptions as QueryObserverOptions$1, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, DefaultOptions as DefaultOptions$1, QueryClientConfig as QueryClientConfig$1, QueryClient as QueryClient$1, QueryObserverResult, DefinedQueryObserverResult, InfiniteQueryObserverResult, MutationObserverOptions, MutateFunction, MutationObserverResult, QueryFilters, InfiniteData, MutationFilters, MutationState, Mutation, QueriesPlaceholderDataFunction, QueryFunction, SkipToken, ThrowOnError } from '@tanstack/query-core';
 type FunctionedParams<T> = () => T;
-interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
+interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
+    /**
+     * Only applicable while rendering queries on the server with streaming.
+     * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
+     * This can be useful to avoid sending a loading state to the client before the query has resolved.
+     * Defaults to `false`.
+     */
     deferStream?: boolean;
+    /**
+     * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+     * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
+     * Setting `suspense` to `false` will be a no-op.
+     */
+    suspense?: boolean;
 }
@@ -46,5 +58,17 @@ interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
 type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
-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'> {
+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'> {
     queryKey: TQueryKey;
+    /**
+     * Only applicable while rendering queries on the server with streaming.
+     * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
+     * This can be useful to avoid sending a loading state to the client before the query has resolved.
+     * Defaults to `false`.
+     */
     deferStream?: boolean;
+    /**
+     * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+     * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
+     * Setting `suspense` to `false` will be a no-op.
+     */
+    suspense?: boolean;
 }
@@ -101,4 +125,11 @@ type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = FunctionedParams<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
 
-type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData'> & {
+type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
     placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
+    /**
+     * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+     * The `data` property on createQueries is a plain object and not a SolidJS Resource.
+     * It will not suspend when the data is loading.
+     * Setting `suspense` to `true` will be a no-op.
+     */
+    suspense?: boolean;
 };
@@ -105,0 +136,0 @@ type MAXIMUM_DEPTH = 20;

package.json

 {
   "name": "@tanstack/solid-query",
-  "version": "5.32.1",
+  "version": "5.33.1",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
@@ -5,0 +5,0 @@ "author": "tannerlinsley",

src/createQueries.ts

@@ -40,5 +40,12 @@ import { QueriesObserver } from '@tanstack/query-core'
   SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-  'placeholderData'
+  'placeholderData' | 'suspense'
 > & {
   placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>
+  /**
+   * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+   * The `data` property on createQueries is a plain object and not a SolidJS Resource.
+   * It will not suspend when the data is loading.
+   * Setting `suspense` to `true` will be a no-op.
+   */
+  suspense?: boolean
 }
@@ -45,0 +52,0 @@

src/types.ts

@@ -27,10 +27,19 @@ /* istanbul ignore file */
   TQueryKey extends QueryKey = QueryKey,
-> extends QueryObserverOptions<
-    TQueryFnData,
-    TError,
-    TData,
-    TQueryData,
-    TQueryKey
+> extends OmitKeyof<
+    QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>,
+    'suspense'
   > {
+  /**
+   * Only applicable while rendering queries on the server with streaming.
+   * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
+   * This can be useful to avoid sending a loading state to the client before the query has resolved.
+   * Defaults to `false`.
+   */
   deferStream?: boolean
+  /**
+   * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+   * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
+   * Setting `suspense` to `false` will be a no-op.
+   */
+  suspense?: boolean
 }
@@ -97,6 +106,18 @@
     >,
-    'queryKey'
+    'queryKey' | 'suspense'
   > {
   queryKey: TQueryKey
+  /**
+   * Only applicable while rendering queries on the server with streaming.
+   * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
+   * This can be useful to avoid sending a loading state to the client before the query has resolved.
+   * Defaults to `false`.
+   */
   deferStream?: boolean
+  /**
+   * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
+   * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
+   * Setting `suspense` to `false` will be a no-op.
+   */
+  suspense?: boolean
 }
@@ -103,0 +124,0 @@

No alert changes

Improved metrics

Total package byte prevSize

447439

increased by1.16%

Lines of code

13471

increased by0.44%

No dependency changes