@tanstack/angular-query-experimental 5.73.3 → 5.74.1

package/build/index.d.ts

@@ -1,6 +1,6 @@
 import { DefaultError, QueryKey, OmitKeyof, QueryObserverOptions, InfiniteQueryObserverOptions, QueryObserverResult, DefinedQueryObserverResult, InfiniteQueryObserverResult, DefinedInfiniteQueryObserverResult, MutateFunction, Override, MutationObserverResult, InitialDataFunction, DataTag, MutationObserverOptions, InfiniteData, QueryFilters, MutationFilters, MutationState, Mutation, QueriesPlaceholderDataFunction, QueryFunction, ThrowOnError, QueryClient } from '@tanstack/query-core';
 export * from '@tanstack/query-core';
-import { Signal, Injector, InjectOptions, Provider, EnvironmentProviders } from '@angular/core';
+import { Signal, Injector, Provider, InjectOptions, EnvironmentProviders } from '@angular/core';
 import { DevtoolsButtonPosition, DevtoolsPosition, DevtoolsErrorType } from '@tanstack/query-devtools';
 
 type MapToSignals<T> = {
@@ -233,6 +233,14 @@ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData
     queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
 };
 
+interface InjectInfiniteQueryOptions {
+    /**
+     * The `Injector` in which to create the infinite query.
+     *
+     * If this is not provided, the current injection context will be used instead (via `inject`).
+     */
+    injector?: Injector;
+}
 /**
  * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
  * Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
@@ -260,17 +268,6 @@ declare function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData
  * @public
  */
 declare function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(injectInfiniteQueryFn: () => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, options?: InjectInfiniteQueryOptions): CreateInfiniteQueryResult<TData, TError>;
-interface InjectInfiniteQueryOptions {
-    /**
-     * The `Injector` in which to create the infinite query.
-     *
-     * If this is not provided, the current injection context will be used instead (via `inject`).
-     */
-    injector?: Injector;
-}
-interface InjectInfiniteQueryOptions {
-    injector?: Injector;
-}
 
 interface InjectIsFetchingOptions {
     /**
@@ -311,6 +308,29 @@ interface InjectIsMutatingOptions {
  */
 declare function injectIsMutating(filters?: MutationFilters, options?: InjectIsMutatingOptions): Signal<number>;
 
+/**
+ * The `Injector` in which to create the isRestoring signal.
+ *
+ * If this is not provided, the current injection context will be used instead (via `inject`).
+ */
+interface InjectIsRestoringOptions {
+    injector?: Injector;
+}
+/**
+ * Injects a signal that tracks whether a restore is currently in progress. {@link injectQuery} and friends also check this internally to avoid race conditions between the restore and mounting queries.
+ * @param options - Options for injectIsRestoring.
+ * @returns signal with boolean that indicates whether a restore is in progress.
+ * @public
+ */
+declare function injectIsRestoring(options?: InjectIsRestoringOptions): Signal<boolean>;
+/**
+ * Used by TanStack Query Angular persist client plugin to provide the signal that tracks the restore state
+ * @param isRestoring - a readonly signal that returns a boolean
+ * @returns Provider for the `isRestoring` signal
+ * @public
+ */
+declare function provideIsRestoring(isRestoring: Signal<boolean>): Provider;
+
 interface InjectMutationOptions {
     /**
      * The `Injector` in which to create the mutation.
@@ -659,6 +679,13 @@ interface QueryFeature<TFeatureKind extends QueryFeatureKind> {
     ɵkind: TFeatureKind;
     ɵproviders: Array<Provider>;
 }
+/**
+ * Helper function to create an object that represents a Query feature.
+ * @param kind -
+ * @param providers -
+ * @returns A Query feature.
+ */
+declare function queryFeature<TFeatureKind extends QueryFeatureKind>(kind: TFeatureKind, providers: Array<Provider>): QueryFeature<TFeatureKind>;
 /**
  * A type alias that represents a feature which enables developer tools.
  * The type is used to describe the return value of the `withDevtools` function.
@@ -666,6 +693,12 @@ interface QueryFeature<TFeatureKind extends QueryFeatureKind> {
  * @see {@link withDevtools}
  */
 type DeveloperToolsFeature = QueryFeature<'DeveloperTools'>;
+/**
+ * A type alias that represents a feature which enables persistence.
+ * The type is used to describe the return value of the `withPersistQueryClient` function.
+ * @public
+ */
+type PersistQueryClientFeature = QueryFeature<'PersistQueryClient'>;
 /**
  * Options for configuring the TanStack Query devtools.
  * @public
@@ -757,8 +790,8 @@ declare function withDevtools(withDevtoolsFn?: () => DevtoolsOptions): Developer
  * @public
  * @see {@link provideTanStackQuery}
  */
-type QueryFeatures = DeveloperToolsFeature;
-declare const queryFeatures: readonly ["DeveloperTools"];
+type QueryFeatures = DeveloperToolsFeature | PersistQueryClientFeature;
+declare const queryFeatures: readonly ["DeveloperTools", "PersistQueryClient"];
 type QueryFeatureKind = (typeof queryFeatures)[number];
 
-export { type BaseMutationNarrowing, type BaseQueryNarrowing, type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type DeveloperToolsFeature, type DevtoolsOptions, type InjectInfiniteQueryOptions, type InjectIsFetchingOptions, type InjectIsMutatingOptions, type InjectMutationOptions, type InjectMutationStateOptions, type InjectQueryOptions, type NonUndefinedGuard, type QueriesOptions, type QueriesResults, type QueryFeature, type QueryFeatureKind, type QueryFeatures, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, infiniteQueryOptions, injectInfiniteQuery, injectIsFetching, injectIsMutating, injectMutation, injectMutationState, injectQueries, injectQuery, injectQueryClient, mutationOptions, provideAngularQuery, provideQueryClient, provideTanStackQuery, queryFeatures, queryOptions, withDevtools };
+export { type BaseMutationNarrowing, type BaseQueryNarrowing, type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type DeveloperToolsFeature, type DevtoolsOptions, type InjectInfiniteQueryOptions, type InjectIsFetchingOptions, type InjectIsMutatingOptions, type InjectMutationOptions, type InjectMutationStateOptions, type InjectQueryOptions, type NonUndefinedGuard, type PersistQueryClientFeature, type QueriesOptions, type QueriesResults, type QueryFeature, type QueryFeatureKind, type QueryFeatures, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, infiniteQueryOptions, injectInfiniteQuery, injectIsFetching, injectIsMutating, injectIsRestoring, injectMutation, injectMutationState, injectQueries, injectQuery, injectQueryClient, mutationOptions, provideAngularQuery, provideIsRestoring, provideQueryClient, provideTanStackQuery, queryFeature, queryFeatures, queryOptions, withDevtools };