@tanstack/svelte-query 6.3.1 → 6.3.2

package/dist/infiniteQueryOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"infiniteQueryOptions.d.ts","sourceRoot":"","sources":["../src/infiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAE5D,MAAM,MAAM,mCAAmC,CAC7C,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,0BAA0B,CAC5B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GAAG;IACF,WAAW,CAAC,EACR,SAAS,GACT,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,GACzD,mBAAmB,CACjB,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAC1D,CAAA;CACN,CAAA;AAED,MAAM,MAAM,iCAAiC,CAC3C,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,0BAA0B,CAC5B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GAAG;IACF,WAAW,EACP,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,GACzD,CAAC,MAAM,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CACtE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,iCAAiC,CACxC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACA,iCAAiC,CAClC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,mCAAmC,CAC1C,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACA,mCAAmC,CACpC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA"}
+{"version":3,"file":"infiniteQueryOptions.d.ts","sourceRoot":"","sources":["../src/infiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAE5D;;;GAGG;AACH,MAAM,MAAM,mCAAmC,CAC7C,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,0BAA0B,CAC5B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GAAG;IACF,WAAW,CAAC,EACR,SAAS,GACT,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,GACzD,mBAAmB,CACjB,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAC1D,CAAA;CACN,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iCAAiC,CAC3C,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,0BAA0B,CAC5B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GAAG;IACF,WAAW,EACP,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,GACzD,CAAC,MAAM,iBAAiB,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CACtE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,iCAAiC,CACxC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACA,iCAAiC,CAClC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,mCAAmC,CAC1C,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACA,mCAAmC,CACpC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,GACC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA"}

package/dist/mutationOptions.d.ts

@@ -4,11 +4,9 @@ import type { CreateMutationOptions } from './types.js';
  * You can generally pass everything to `mutationOptions` that you can also pass to `createMutation`. This
  * overload requires `mutationKey`, so the resulting options can be looked up elsewhere (e.g. with
  * `useMutationState`).
- *
- * @see {@link createMutation} to run a mutation with these options.
  * @param options - The options to use — everything you can pass to `createMutation`, with `mutationKey` set.
  * @returns The same options object.
- *
+ * @see {@link createMutation} to run a mutation with these options.
  * @example
  * Looking the mutation up elsewhere via its `mutationKey`, e.g. for a global "saving…" indicator:
  * ```svelte
@@ -33,11 +31,9 @@ import type { CreateMutationOptions } from './types.js';
 export declare function mutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(options: WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>): WithRequired<CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>, 'mutationKey'>;
 /**
  * You can generally pass everything to `mutationOptions` that you can also pass to `createMutation`.
- *
- * @see {@link createMutation} to run a mutation with these options.
  * @param options - The options to use — everything you can pass to `createMutation`.
  * @returns The same options object.
- *
+ * @see {@link createMutation} to run a mutation with these options.
  * @example
  * ```svelte
  * <script lang="ts">

package/dist/mutationOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutationOptions.d.ts","sourceRoot":"","sources":["../src/mutationOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,eAAe,CAC7B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,EAEzB,OAAO,EAAE,YAAY,CACnB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,GACA,YAAY,CACb,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,eAAe,CAC7B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,EAEzB,OAAO,EAAE,IAAI,CACX,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,GACA,IAAI,CACL,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,CAAA"}
+{"version":3,"file":"mutationOptions.d.ts","sourceRoot":"","sources":["../src/mutationOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAC7B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,EAEzB,OAAO,EAAE,YAAY,CACnB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,GACA,YAAY,CACb,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAC7B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,EAEzB,OAAO,EAAE,IAAI,CACX,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,GACA,IAAI,CACL,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACjE,aAAa,CACd,CAAA"}

package/dist/queryOptions.d.ts

@@ -1,8 +1,16 @@
 import type { DefaultError, InitialDataFunction, NonUndefinedGuard, QueryKey, QueryKeyWithDataTag } from '@tanstack/query-core';
 import type { CreateQueryOptions } from './types.js';
+/**
+ * The options accepted by the `queryOptions` overload selected when `initialData` is omitted or may be
+ * `undefined` — `data` may be `undefined` while the query is `pending`.
+ */
 export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
     initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>> | NonUndefinedGuard<TQueryFnData>;
 };
+/**
+ * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never
+ * `undefined` (unless a `select` changes `TData` to include `undefined`).
+ */
 export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
     initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
 };
@@ -13,12 +21,10 @@ export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultEr
  *
  * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless
  * a `select` changes `TData` to include `undefined`).
- *
- * @see {@link createQuery} to run a query with these options.
  * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `createQuery`,
  * with `initialData` set.
  * @returns The same options object, typed so that `queryKey` carries the inferred data type.
- *
+ * @see {@link createQuery} to run a query with these options.
  * @example
  * ```svelte
  * <script lang="ts">
@@ -50,11 +56,9 @@ export declare function queryOptions<TQueryFnData = unknown, TError = DefaultErr
  * You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options
  * can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey`
  * is required and is the query key to generate options for.
- *
- * @see {@link createQuery} to run a query with these options.
  * @param options - The {@link UndefinedInitialDataOptions} to use — everything you can pass to `createQuery`.
  * @returns The same options object, typed so that `queryKey` carries the inferred data type.
- *
+ * @see {@link createQuery} to run a query with these options.
  * @example
  * A parameterized factory, so the same options object can be reused per `id`:
  * ```svelte

package/dist/queryOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryOptions.d.ts","sourceRoot":"","sources":["../src/queryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,MAAM,MAAM,2BAA2B,CACrC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,CAAC,EACR,SAAS,GACT,mBAAmB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,GACpD,iBAAiB,CAAC,YAAY,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,yBAAyB,CACnC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,EACT,iBAAiB,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAA;CAC5E,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GACzE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAClE,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAC3E,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GACpE,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA"}
+{"version":3,"file":"queryOptions.d.ts","sourceRoot":"","sources":["../src/queryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD;;;GAGG;AACH,MAAM,MAAM,2BAA2B,CACrC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,CAAC,EACR,SAAS,GACT,mBAAmB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,GACpD,iBAAiB,CAAC,YAAY,CAAC,CAAA;CACpC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,CACnC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,EACP,iBAAiB,CAAC,YAAY,CAAC,GAC/B,CAAC,MAAM,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAA;CAC5C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GACzE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAClE,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAC3E,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GACpE,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,MAAM,CAAC,CAAA"}

package/dist/types.d.ts

@@ -1,5 +1,9 @@
 import type { Snippet } from 'svelte';
 import type { DefaultError, DefinedInfiniteQueryObserverResult, DefinedQueryObserverResult, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, Mutation, MutationFilters, MutationObserverOptions, MutationObserverResult, MutationState, OmitKeyof, Override, QueryClient, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
+/**
+ * A function that returns a value. Options passed as an accessor are read inside reactive contexts, so they
+ * update when the state they read changes.
+ */
 export type Accessor<T> = () => T;
 /** Options for createBaseQuery */
 export type CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
@@ -21,8 +25,22 @@ export type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError>
 export type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
 /** Options for createMutation */
 export type CreateMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, '_defaulted'>;
+/**
+ * The type of `mutate`, as returned by `createMutation`. Forwards the variables (and an optional per-call
+ * `onSuccess`/`onError`/`onSettled`) to the underlying `mutate` call. Fire-and-forget — errors are surfaced
+ * through the mutation result, not thrown.
+ */
 export type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
+/**
+ * The type of `mutateAsync`, as returned by `createMutation`. Similar to {@link CreateMutateFunction}, but
+ * returns a promise which can be awaited.
+ */
 export type CreateMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
+/**
+ * The result of `createMutation`. Same as {@link MutationObserverResult} from `@tanstack/query-core`, with
+ * `mutate` narrowed to the fire-and-forget {@link CreateMutateFunction} signature, plus the added
+ * `mutateAsync`.
+ */
 export type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TOnMutateResult>, {
     mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>;
 }> & {
@@ -30,16 +48,35 @@ export type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVa
 };
 /** Result from createMutation */
 export type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TOnMutateResult = unknown> = CreateBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
+/**
+ * Infers the `Mutation` type passed to `useMutationState`'s `select` from the `MutationState` type it
+ * returns, falling back to `Mutation` otherwise.
+ */
 export type MutationTypeFromResult<TResult> = [TResult] extends [
     MutationState<infer TData, infer TError, infer TVariables, infer TOnMutateResult>
 ] ? Mutation<TData, TError, TVariables, TOnMutateResult> : Mutation;
 /** Options for useMutationState */
 export type MutationStateOptions<TResult = MutationState, TMutation extends Mutation<any, any, any, any> = MutationTypeFromResult<TResult>> = {
+    /**
+     * The filters that select the mutations to return the state of.
+     */
     filters?: MutationFilters;
+    /**
+     * Maps each matching mutation to the value returned for it. Defaults to the mutation's `state`.
+     */
     select?: (mutation: TMutation) => TResult;
 };
+/**
+ * The props accepted by `QueryClientProvider`.
+ */
 export type QueryClientProviderProps = {
+    /**
+     * The `QueryClient` to provide to the children.
+     */
     client: QueryClient;
+    /**
+     * The children that can use the provided `QueryClient`.
+     */
     children: Snippet;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,KAAK,EACV,YAAY,EACZ,kCAAkC,EAClC,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,cAAc,EACd,QAAQ,EACR,eAAe,EACf,uBAAuB,EACvB,sBAAsB,EACtB,aAAa,EACb,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA;AAEjC,kCAAkC;AAClC,MAAM,MAAM,sBAAsB,CAChC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,EACzB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;AAE5E,kCAAkC;AAClC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAEtC,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,CAC5B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,CAAA;AAEhF,8BAA8B;AAC9B,MAAM,MAAM,iBAAiB,CAC3B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAExC,sCAAsC;AACtC,MAAM,MAAM,0BAA0B,CACpC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,4BAA4B,CAC9B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,2BAA2B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE9C,uDAAuD;AACvD,MAAM,MAAM,gCAAgC,CAC1C,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,kCAAkC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAErD,mDAAmD;AACnD,MAAM,MAAM,4BAA4B,CACtC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE7C,+CAA+C;AAC/C,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,4BAA4B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE/C,iCAAiC;AACjC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,SAAS,CACX,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACnE,YAAY,CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,CACF,GAAG,IAAI,EAAE,UAAU,CACjB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAC3D,KACE,IAAI,CAAA;AAET,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;AAE9D,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,eAAe,GAAG,OAAO,IACvB,QAAQ,CACV,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EAClE;IAAE,MAAM,EAAE,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;CAAE,CAC7E,GAAG;IACF,WAAW,EAAE,yBAAyB,CACpC,KAAK,EACL,MAAM,EACN,UAAU,EACV,eAAe,CAChB,CAAA;CACF,CAAA;AAED,iCAAiC;AACjC,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,eAAe,GAAG,OAAO,IACvB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;AAExE,MAAM,MAAM,sBAAsB,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS;IAC9D,aAAa,CACX,MAAM,KAAK,EACX,MAAM,MAAM,EACZ,MAAM,UAAU,EAChB,MAAM,eAAe,CACtB;CACF,GACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,GACpD,QAAQ,CAAA;AAEZ,mCAAmC;AACnC,MAAM,MAAM,oBAAoB,CAC9B,OAAO,GAAG,aAAa,EACvB,SAAS,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5C,sBAAsB,CAAC,OAAO,CAAC,IAC/B;IACF,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,WAAW,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,KAAK,EACV,YAAY,EACZ,kCAAkC,EAClC,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,cAAc,EACd,QAAQ,EACR,eAAe,EACf,uBAAuB,EACvB,sBAAsB,EACtB,aAAa,EACb,SAAS,EACT,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAE7B;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA;AAEjC,kCAAkC;AAClC,MAAM,MAAM,sBAAsB,CAChC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,EACzB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;AAE5E,kCAAkC;AAClC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAEtC,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,CAC5B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,CAAA;AAEhF,8BAA8B;AAC9B,MAAM,MAAM,iBAAiB,CAC3B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAExC,sCAAsC;AACtC,MAAM,MAAM,0BAA0B,CACpC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,4BAA4B,CAC9B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACX,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,2BAA2B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE9C,uDAAuD;AACvD,MAAM,MAAM,gCAAgC,CAC1C,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,kCAAkC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAErD,mDAAmD;AACnD,MAAM,MAAM,4BAA4B,CACtC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE7C,+CAA+C;AAC/C,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,4BAA4B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE/C,iCAAiC;AACjC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,SAAS,CACX,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EACnE,YAAY,CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,CACF,GAAG,IAAI,EAAE,UAAU,CACjB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAC3D,KACE,IAAI,CAAA;AAET;;;GAGG;AACH,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,eAAe,GAAG,OAAO,IACvB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,eAAe,GAAG,OAAO,IACvB,QAAQ,CACV,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,EAClE;IAAE,MAAM,EAAE,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;CAAE,CAC7E,GAAG;IACF,WAAW,EAAE,yBAAyB,CACpC,KAAK,EACL,MAAM,EACN,UAAU,EACV,eAAe,CAChB,CAAA;CACF,CAAA;AAED,iCAAiC;AACjC,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,eAAe,GAAG,OAAO,IACvB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;AAExE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS;IAC9D,aAAa,CACX,MAAM,KAAK,EACX,MAAM,MAAM,EACZ,MAAM,UAAU,EAChB,MAAM,eAAe,CACtB;CACF,GACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,CAAC,GACpD,QAAQ,CAAA;AAEZ,mCAAmC;AACnC,MAAM,MAAM,oBAAoB,CAC9B,OAAO,GAAG,aAAa,EACvB,SAAS,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5C,sBAAsB,CAAC,OAAO,CAAC,IAC/B;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA"}

package/dist/useHydrate.d.ts

@@ -4,12 +4,10 @@ import type { HydrateOptions, QueryClient } from '@tanstack/query-core';
  * passed explicitly). If the client already contains data, the new queries will be intelligently merged based
  * on update timestamp. `HydrationBoundary` wraps this — use it directly only if you need to hydrate from your
  * own component instead.
- *
  * @param state - The dehydrated state to hydrate into the cache, as produced by `dehydrate`.
  * @param options - {@link HydrateOptions} to control the hydration.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
- *
  * @example
  * Server-side prefetch handed off to the client via `dehydrate` — `dehydratedState` would typically come
  * from a server load function that prefetched with `queryClient.query` and called `dehydrate(queryClient)`:

package/dist/useHydrate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useHydrate.d.ts","sourceRoot":"","sources":["../src/useHydrate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CACxB,KAAK,CAAC,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,cAAc,EACxB,WAAW,CAAC,EAAE,WAAW,QAO1B"}
+{"version":3,"file":"useHydrate.d.ts","sourceRoot":"","sources":["../src/useHydrate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,UAAU,CACxB,KAAK,CAAC,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,cAAc,EACxB,WAAW,CAAC,EAAE,WAAW,QAO1B"}

package/dist/useHydrate.js

@@ -5,12 +5,10 @@ import { useQueryClient } from './useQueryClient.js';
  * passed explicitly). If the client already contains data, the new queries will be intelligently merged based
  * on update timestamp. `HydrationBoundary` wraps this — use it directly only if you need to hydrate from your
  * own component instead.
- *
  * @param state - The dehydrated state to hydrate into the cache, as produced by `dehydrate`.
  * @param options - {@link HydrateOptions} to control the hydration.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
- *
  * @example
  * Server-side prefetch handed off to the client via `dehydrate` — `dehydratedState` would typically come
  * from a server load function that prefetched with `queryClient.query` and called `dehydrate(queryClient)`:

package/dist/useIsFetching.svelte.d.ts

@@ -3,13 +3,11 @@ import type { QueryClient, QueryFilters } from '@tanstack/query-core';
 /**
  * The `useIsFetching` function returns the `number` of the queries that your application is loading or
  * fetching in the background (useful for app-wide loading indicators).
- *
  * @param filters - {@link QueryFilters} to narrow down which queries to count. Omit to count every fetching
  * query.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns A reactive value — read `.current` to get how many matching queries are currently fetching.
- *
  * @example
  * ```svelte
  * <script lang="ts">
@@ -23,7 +21,6 @@ import type { QueryClient, QueryFilters } from '@tanstack/query-core';
  *   <span>Refreshing posts...</span>
  * {/if}
  * ```
- *
  * @example
  * A global loading indicator for any query fetching in the background, not just the ones on screen:
  * ```svelte

package/dist/useIsFetching.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useIsFetching.svelte.d.ts","sourceRoot":"","sources":["../src/useIsFetching.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAEtD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,aAAa,CAAC,MAAM,CAAC,CAQvB"}
+{"version":3,"file":"useIsFetching.svelte.d.ts","sourceRoot":"","sources":["../src/useIsFetching.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAEtD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,aAAa,CAAC,MAAM,CAAC,CAQvB"}

package/dist/useIsFetching.svelte.js

@@ -3,13 +3,11 @@ import { useQueryClient } from './useQueryClient.js';
 /**
  * The `useIsFetching` function returns the `number` of the queries that your application is loading or
  * fetching in the background (useful for app-wide loading indicators).
- *
  * @param filters - {@link QueryFilters} to narrow down which queries to count. Omit to count every fetching
  * query.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns A reactive value — read `.current` to get how many matching queries are currently fetching.
- *
  * @example
  * ```svelte
  * <script lang="ts">
@@ -23,7 +21,6 @@ import { useQueryClient } from './useQueryClient.js';
  *   <span>Refreshing posts...</span>
  * {/if}
  * ```
- *
  * @example
  * A global loading indicator for any query fetching in the background, not just the ones on screen:
  * ```svelte

package/dist/useIsMutating.svelte.d.ts

@@ -3,12 +3,10 @@ import type { MutationFilters, QueryClient } from '@tanstack/query-core';
 /**
  * `useIsMutating` is an optional function that returns the `number` of mutations that your application is
  * running (useful for app-wide loading indicators).
- *
  * @param filters - {@link MutationFilters} to narrow down which mutations to count.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns A reactive value — read `.current` to get how many matching mutations are currently running.
- *
  * @example
  * ```svelte
  * <script lang="ts">

package/dist/useIsMutating.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useIsMutating.svelte.d.ts","sourceRoot":"","sources":["../src/useIsMutating.svelte.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,eAAe,EACzB,WAAW,CAAC,EAAE,WAAW,GACxB,aAAa,CAAC,MAAM,CAAC,CAQvB"}
+{"version":3,"file":"useIsMutating.svelte.d.ts","sourceRoot":"","sources":["../src/useIsMutating.svelte.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,eAAe,EACzB,WAAW,CAAC,EAAE,WAAW,GACxB,aAAa,CAAC,MAAM,CAAC,CAQvB"}

package/dist/useIsMutating.svelte.js

@@ -3,12 +3,10 @@ import { ReactiveValue } from './containers.svelte.js';
 /**
  * `useIsMutating` is an optional function that returns the `number` of mutations that your application is
  * running (useful for app-wide loading indicators).
- *
  * @param filters - {@link MutationFilters} to narrow down which mutations to count.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns A reactive value — read `.current` to get how many matching mutations are currently running.
- *
  * @example
  * ```svelte
  * <script lang="ts">

package/dist/useIsRestoring.d.ts

@@ -3,7 +3,6 @@ import type { Box } from './containers.svelte.js';
  * If you are using `PersistQueryClientProvider`, you can also use the `useIsRestoring` function alongside it to
  * check if a restore is currently in progress. `createQuery` and friends also check this internally to avoid
  * race conditions between the restore and mounting queries.
- *
  * @returns A reactive box — read `.current` for `true` while a persisted client is being restored, `false`
  * otherwise.
  * @example

package/dist/useIsRestoring.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useIsRestoring.d.ts","sourceRoot":"","sources":["../src/useIsRestoring.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC,OAAO,CAAC,CAE7C"}
+{"version":3,"file":"useIsRestoring.d.ts","sourceRoot":"","sources":["../src/useIsRestoring.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAA;AAEjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC,OAAO,CAAC,CAE7C"}

package/dist/useIsRestoring.js

@@ -3,7 +3,6 @@ import { getIsRestoringContext } from './context.js';
  * If you are using `PersistQueryClientProvider`, you can also use the `useIsRestoring` function alongside it to
  * check if a restore is currently in progress. `createQuery` and friends also check this internally to avoid
  * race conditions between the restore and mounting queries.
- *
  * @returns A reactive box — read `.current` for `true` while a persisted client is being restored, `false`
  * otherwise.
  * @example

package/dist/useMutationState.svelte.d.ts

@@ -4,13 +4,11 @@ import type { MutationStateOptions, MutationTypeFromResult } from './types.js';
  * `useMutationState` is a function that gives you access to all mutations in the `MutationCache`. You can pass
  * `filters` ({@link MutationFilters}) to narrow down your mutations, and `select` to transform the mutation
  * state.
- *
  * @param options - The `filters` to narrow down matched mutations, and an optional `select` to transform the
  * mutation state.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns An Array of whatever `select` returns for each matching mutation.
- *
  * @example
  * Get all variables of all running mutations:
  * ```svelte
@@ -25,7 +23,6 @@ import type { MutationStateOptions, MutationTypeFromResult } from './types.js';
  *
  * {pendingVariables.length} posts saving...
  * ```
- *
  * @example
  * Get all data for specific mutations via the `mutationKey`:
  * ```svelte
@@ -51,7 +48,6 @@ import type { MutationStateOptions, MutationTypeFromResult } from './types.js';
  *   Create post ({savedPosts.length} saved so far)
  * </button>
  * ```
- *
  * @example
  * Access the latest mutation data via the `mutationKey`. Each invocation of `mutate` adds a new entry to the
  * mutation cache for `gcTime` milliseconds — check the last item that `useMutationState` returns to get the

package/dist/useMutationState.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useMutationState.svelte.d.ts","sourceRoot":"","sources":["../src/useMutationState.svelte.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,QAAQ,EAER,aAAa,EACb,WAAW,EACZ,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAoB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAG,aAAa,EACvB,SAAS,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5C,sBAAsB,CAAC,OAAO,CAAC,EAEjC,OAAO,GAAE,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAM,EACtD,WAAW,CAAC,EAAE,WAAW,GACxB,KAAK,CAAC,OAAO,CAAC,CA+BhB"}
+{"version":3,"file":"useMutationState.svelte.d.ts","sourceRoot":"","sources":["../src/useMutationState.svelte.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,QAAQ,EAER,aAAa,EACb,WAAW,EACZ,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AA2B9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAG,aAAa,EACvB,SAAS,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5C,sBAAsB,CAAC,OAAO,CAAC,EAEjC,OAAO,GAAE,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAM,EACtD,WAAW,CAAC,EAAE,WAAW,GACxB,KAAK,CAAC,OAAO,CAAC,CA+BhB"}

package/dist/useMutationState.svelte.js

@@ -1,5 +1,12 @@
 import { replaceEqualDeep } from '@tanstack/query-core';
 import { useQueryClient } from './useQueryClient.js';
+/**
+ * Collects the mutations in the cache that match `options.filters`, mapped with `options.select`
+ * (or to their state, by default).
+ * @param mutationCache - The mutation cache to read.
+ * @param options - The `filters` to match and the `select` function to map each mutation with.
+ * @returns The selected value of every matching mutation.
+ */
 function getResult(mutationCache, options) {
     return mutationCache
         .findAll(options.filters)
@@ -11,13 +18,11 @@ function getResult(mutationCache, options) {
  * `useMutationState` is a function that gives you access to all mutations in the `MutationCache`. You can pass
  * `filters` ({@link MutationFilters}) to narrow down your mutations, and `select` to transform the mutation
  * state.
- *
  * @param options - The `filters` to narrow down matched mutations, and an optional `select` to transform the
  * mutation state.
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns An Array of whatever `select` returns for each matching mutation.
- *
  * @example
  * Get all variables of all running mutations:
  * ```svelte
@@ -32,7 +37,6 @@ function getResult(mutationCache, options) {
  *
  * {pendingVariables.length} posts saving...
  * ```
- *
  * @example
  * Get all data for specific mutations via the `mutationKey`:
  * ```svelte
@@ -58,7 +62,6 @@ function getResult(mutationCache, options) {
  *   Create post ({savedPosts.length} saved so far)
  * </button>
  * ```
- *
  * @example
  * Access the latest mutation data via the `mutationKey`. Each invocation of `mutate` adds a new entry to the
  * mutation cache for `gcTime` milliseconds — check the last item that `useMutationState` returns to get the

package/dist/useQueryClient.d.ts

@@ -1,11 +1,11 @@
 import type { QueryClient } from '@tanstack/query-core';
 /**
  * The `useQueryClient` function returns the current `QueryClient` instance.
- *
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns The current `QueryClient` instance.
- * @throws If no `queryClient` argument is passed and no `QueryClientProvider` is found in the component tree.
+ * @throws {Error} If no `queryClient` argument is passed and no `QueryClientProvider` is found in the
+ * component tree.
  * @example
  * ```svelte
  * <script lang="ts">

package/dist/useQueryClient.js

@@ -1,11 +1,11 @@
 import { getQueryClientContext } from './context.js';
 /**
  * The `useQueryClient` function returns the current `QueryClient` instance.
- *
  * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
  * be used.
  * @returns The current `QueryClient` instance.
- * @throws If no `queryClient` argument is passed and no `QueryClientProvider` is found in the component tree.
+ * @throws {Error} If no `queryClient` argument is passed and no `QueryClientProvider` is found in the
+ * component tree.
  * @example
  * ```svelte
  * <script lang="ts">

package/dist/utils.svelte.d.ts

@@ -1,4 +1,12 @@
 type Getter<T> = () => T;
+/**
+ * Runs `effect` whenever the reactive state read by `sources` changes, even if they return the
+ * same values, skipping the first run. The effect receives the new and previous values, and is
+ * called untracked, so only `sources` are tracked.
+ * @param sources - The getter, or array of getters, to watch.
+ * @param flush - Whether to run after (`'post'`) or before (`'pre'`) the DOM updates.
+ * @param effect - Called with the new and previous values. It may return a cleanup function.
+ */
 export declare const watchChanges: <T>(sources: Getter<T> | Array<Getter<T>>, flush: "post" | "pre", effect: (values: T | Array<T>, previousValues: T | undefined | Array<T | undefined>) => void) => void;
 export {};
 //# sourceMappingURL=utils.svelte.d.ts.map

package/dist/utils.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.svelte.d.ts","sourceRoot":"","sources":["../src/utils.svelte.ts"],"names":[],"mappings":"AAeA,KAAK,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA;AACxB,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,SAAS,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACrC,OAAO,MAAM,GAAG,KAAK,EACrB,QAAQ,CACN,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EACpB,cAAc,EAAE,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,KACjD,IAAI,SAqBV,CAAA"}
+{"version":3,"file":"utils.svelte.d.ts","sourceRoot":"","sources":["../src/utils.svelte.ts"],"names":[],"mappings":"AAoBA,KAAK,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA;AACxB;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,SAAS,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACrC,OAAO,MAAM,GAAG,KAAK,EACrB,QAAQ,CACN,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EACpB,cAAc,EAAE,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,KACjD,IAAI,SAqBV,CAAA"}

package/dist/utils.svelte.js

@@ -1,5 +1,10 @@
 import { untrack } from 'svelte';
 // modified from the great https://github.com/svecosystem/runed
+/**
+ * Runs an effect after (`'post'`) or before (`'pre'`) the DOM updates.
+ * @param flush - When to run the effect: `'post'` uses `$effect`, `'pre'` uses `$effect.pre`.
+ * @param effect - The effect to run. It may return a cleanup function.
+ */
 function runEffect(flush, effect) {
     switch (flush) {
         case 'post':
@@ -10,6 +15,14 @@ function runEffect(flush, effect) {
             break;
     }
 }
+/**
+ * Runs `effect` whenever the reactive state read by `sources` changes, even if they return the
+ * same values, skipping the first run. The effect receives the new and previous values, and is
+ * called untracked, so only `sources` are tracked.
+ * @param sources - The getter, or array of getters, to watch.
+ * @param flush - Whether to run after (`'post'`) or before (`'pre'`) the DOM updates.
+ * @param effect - Called with the new and previous values. It may return a cleanup function.
+ */
 export const watchChanges = (sources, flush, effect) => {
     let active = false;
     let previousValues = Array.isArray(sources)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-query",
-  "version": "6.3.1",
+  "version": "6.3.2",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
   "author": "Lachlan Collins",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.104.1"
+    "@tanstack/query-core": "5.104.2"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.5.8",
     "@sveltejs/vite-plugin-svelte": "^7.3.1",
     "@tanstack/query-test-utils": "0.0.0",
     "@testing-library/svelte": "^5.2.8",
-    "@typescript-eslint/parser": "^8.70.1",
+    "@typescript-eslint/parser": "^8.71.0",
     "eslint-plugin-svelte": "^3.23.0",
     "svelte": "^5.57.1",
     "svelte-check": "^4.4.5",
@@ -59,12 +59,12 @@
     "clean": "premove ./dist ./coverage ./.svelte-kit ./dist-ts",
     "compile": "tsc --project tsconfig.json",
     "test:types": "npm-run-all --serial test:types:*",
-    "test:types:ts56": "node -e \"const Module = require('module'); const resolveFilename = Module._resolveFilename; let swapped = false; Module._resolveFilename = function (request, ...args) { if (request === 'typescript' || request.startsWith('typescript/')) { request = request.replace('typescript', 'typescript56'); swapped = true } return resolveFilename.call(this, request, ...args) }; process.on('exit', () => { if (!swapped) { console.error('svelte-check did not load typescript56'); process.exitCode = 1 } }); process.argv.splice(1, 0, ''); require('svelte-check/bin/svelte-check')\" -- --tsconfig ./tsconfig.legacy.json",
     "test:types:ts57": "node -e \"const Module = require('module'); const resolveFilename = Module._resolveFilename; let swapped = false; Module._resolveFilename = function (request, ...args) { if (request === 'typescript' || request.startsWith('typescript/')) { request = request.replace('typescript', 'typescript57'); swapped = true } return resolveFilename.call(this, request, ...args) }; process.on('exit', () => { if (!swapped) { console.error('svelte-check did not load typescript57'); process.exitCode = 1 } }); process.argv.splice(1, 0, ''); require('svelte-check/bin/svelte-check')\" -- --tsconfig ./tsconfig.legacy.json",
     "test:types:ts58": "node -e \"const Module = require('module'); const resolveFilename = Module._resolveFilename; let swapped = false; Module._resolveFilename = function (request, ...args) { if (request === 'typescript' || request.startsWith('typescript/')) { request = request.replace('typescript', 'typescript58'); swapped = true } return resolveFilename.call(this, request, ...args) }; process.on('exit', () => { if (!swapped) { console.error('svelte-check did not load typescript58'); process.exitCode = 1 } }); process.argv.splice(1, 0, ''); require('svelte-check/bin/svelte-check')\" -- --tsconfig ./tsconfig.legacy.json",
     "test:types:ts59": "node -e \"const Module = require('module'); const resolveFilename = Module._resolveFilename; let swapped = false; Module._resolveFilename = function (request, ...args) { if (request === 'typescript' || request.startsWith('typescript/')) { request = request.replace('typescript', 'typescript59'); swapped = true } return resolveFilename.call(this, request, ...args) }; process.on('exit', () => { if (!swapped) { console.error('svelte-check did not load typescript59'); process.exitCode = 1 } }); process.argv.splice(1, 0, ''); require('svelte-check/bin/svelte-check')\" -- --tsconfig ./tsconfig.legacy.json",
     "test:types:tscurrent": "svelte-check --tsconfig ./tsconfig.json",
     "test:eslint": "eslint --concurrency=auto ./src ./tests",
+    "test:oxlint": "oxlint ./src ./tests",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm run test:lib --watch",
     "test:build": "publint --strict && attw --pack",

package/src/containers.svelte.ts

@@ -3,8 +3,20 @@ import { SvelteSet, createSubscriber } from 'svelte/reactivity'
 type VoidFn = () => void
 type Subscriber = (update: VoidFn) => void | VoidFn
 
-export type Box<T> = { current: T }
+/**
+ * An object holding a value in its `current` property, e.g. a reactive value backed by `$state`.
+ */
+export type Box<T> = {
+  /**
+   * The held value.
+   */
+  current: T
+}
 
+/**
+ * A {@link Box} whose `current` value is computed on each read, and that notifies the reactive
+ * contexts reading it through the given subscriber.
+ */
 export class ReactiveValue<T> implements Box<T> {
   #fn
   #subscribe
@@ -14,6 +26,10 @@ export class ReactiveValue<T> implements Box<T> {
     this.#subscribe = createSubscriber((update) => onSubscribe(update))
   }
 
+  /**
+   * Subscribes the reactive context reading it, then computes the value.
+   * @returns The value returned by the compute function.
+   */
   get current() {
     this.#subscribe()
     return this.#fn()
@@ -25,6 +41,8 @@ export class ReactiveValue<T> implements Box<T> {
  * are the same as in the original object. Does not mutate the original object. Provides an `update`
  * function that _can_ (but does not have to be) be used to replace all of the object's top-level keys
  * with the values of the new object, while maintaining the original root object's reference.
+ * @param init - The object or array whose top-level keys become the initial fields.
+ * @returns A tuple of the reactive object and the `update` function.
  */
 export function createRawRef<T extends {} | Array<unknown>>(
   init: T,
@@ -99,6 +117,11 @@ export function createRawRef<T extends {} | Array<unknown>>(
     },
   })
 
+  /**
+   * Replaces the top-level keys of the reactive object with those of `newValue`, removing keys that
+   * `newValue` doesn't have, while keeping the object's reference.
+   * @param newValue - The object or array to take the new keys and values from.
+   */
   function update(newValue: T) {
     const existingKeys = Object.keys(out)
     const newKeys = Object.keys(newValue)
@@ -138,12 +161,23 @@ export function createRawRef<T extends {} | Array<unknown>>(
 const lazyBrand = Symbol('LazyValue')
 type Branded<T extends () => unknown> = T & { [lazyBrand]: true }
 
+/**
+ * Marks a function as a lazy value, so that reading the property it is stored in calls it instead of
+ * returning the function.
+ * @param fn - The function that returns the value.
+ * @returns The same function, marked as lazy.
+ */
 function brand<T extends () => unknown>(fn: T): Branded<T> {
   // @ts-expect-error
   fn[lazyBrand] = true
   return fn as Branded<T>
 }
 
+/**
+ * Checks whether a function was marked as a lazy value with {@link brand}.
+ * @param fn - The function to check.
+ * @returns `true` if the function is marked as lazy.
+ */
 function isBranded<T extends () => unknown>(fn: T): fn is Branded<T> {
   return Boolean((fn as Branded<T>)[lazyBrand])
 }