From 7c0dad53da6d5250cbecf2bb2ca7ecd5bed325b2 Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Sat, 19 Sep 2026 16:53:31 +0900 Subject: [PATCH] docs(query-core): add JSDoc for 'initialPageParam' --- .../angular/reference/interfaces/CancelOptions.md | 2 +- .../reference/interfaces/CreateInfiniteQueryOptions.md | 2 +- .../angular/reference/interfaces/DefaultOptions.md | 2 +- .../angular/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../angular/reference/interfaces/FetchNextPageOptions.md | 2 +- .../reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../angular/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../angular/reference/interfaces/InitialPageParam.md | 6 +++--- .../angular/reference/interfaces/InvalidateOptions.md | 2 +- .../angular/reference/interfaces/InvalidateQueryFilters.md | 2 +- .../angular/reference/interfaces/MutateOptions.md | 2 +- .../reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- .../angular/reference/interfaces/MutationOptions.md | 2 +- docs/framework/angular/reference/interfaces/NotifyEvent.md | 2 +- .../angular/reference/interfaces/QueryClientConfig.md | 2 +- .../angular/reference/interfaces/QueryExecuteOptions.md | 2 +- .../reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../angular/reference/interfaces/QueryObserverOptions.md | 2 +- .../reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../reference/interfaces/QueryObserverSuccessResult.md | 2 +- .../angular/reference/interfaces/RefetchOptions.md | 2 +- .../angular/reference/interfaces/RefetchQueryFilters.md | 2 +- .../framework/angular/reference/interfaces/ResetOptions.md | 2 +- .../angular/reference/interfaces/ResultOptions.md | 2 +- .../angular/reference/interfaces/SetDataOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../angular/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../angular/reference/type-aliases/MutateFunction.md | 2 +- .../angular/reference/type-aliases/MutateFunctionRest.md | 2 +- .../angular/reference/type-aliases/MutationFunction.md | 2 +- .../reference/type-aliases/MutationFunctionContext.md | 2 +- .../angular/reference/type-aliases/MutationKey.md | 2 +- .../angular/reference/type-aliases/MutationMeta.md | 2 +- .../reference/type-aliases/MutationObserverResult.md | 2 +- .../angular/reference/type-aliases/MutationScope.md | 2 +- .../angular/reference/type-aliases/MutationStatus.md | 2 +- .../angular/reference/type-aliases/NotifyEventType.md | 2 +- .../angular/reference/type-aliases/QueryObserverResult.md | 2 +- .../angular/reference/type-aliases/QueryStatus.md | 2 +- .../angular/reference/type-aliases/ThrowOnError.md | 2 +- .../angular/reference/type-aliases/WithRequired.md | 2 +- docs/framework/lit/reference/interfaces/CancelOptions.md | 2 +- docs/framework/lit/reference/interfaces/DefaultOptions.md | 2 +- .../lit/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../lit/reference/interfaces/FetchNextPageOptions.md | 2 +- .../lit/reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../lit/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../framework/lit/reference/interfaces/InitialPageParam.md | 6 +++--- .../lit/reference/interfaces/InvalidateOptions.md | 2 +- .../lit/reference/interfaces/InvalidateQueryFilters.md | 2 +- docs/framework/lit/reference/interfaces/MutateOptions.md | 2 +- .../lit/reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../lit/reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../lit/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- docs/framework/lit/reference/interfaces/MutationOptions.md | 2 +- docs/framework/lit/reference/interfaces/NotifyEvent.md | 2 +- .../lit/reference/interfaces/QueryClientConfig.md | 2 +- .../lit/reference/interfaces/QueryExecuteOptions.md | 2 +- .../lit/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../lit/reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../lit/reference/interfaces/QueryObserverOptions.md | 2 +- .../lit/reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../lit/reference/interfaces/QueryObserverSuccessResult.md | 2 +- docs/framework/lit/reference/interfaces/RefetchOptions.md | 2 +- .../lit/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/lit/reference/interfaces/ResetOptions.md | 2 +- docs/framework/lit/reference/interfaces/ResultOptions.md | 2 +- docs/framework/lit/reference/interfaces/SetDataOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- docs/framework/lit/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../framework/lit/reference/type-aliases/MutateFunction.md | 2 +- .../lit/reference/type-aliases/MutateFunctionRest.md | 2 +- .../lit/reference/type-aliases/MutationFunction.md | 2 +- .../lit/reference/type-aliases/MutationFunctionContext.md | 2 +- docs/framework/lit/reference/type-aliases/MutationKey.md | 2 +- docs/framework/lit/reference/type-aliases/MutationMeta.md | 2 +- .../lit/reference/type-aliases/MutationObserverResult.md | 2 +- docs/framework/lit/reference/type-aliases/MutationScope.md | 2 +- .../framework/lit/reference/type-aliases/MutationStatus.md | 2 +- .../lit/reference/type-aliases/NotifyEventType.md | 2 +- .../lit/reference/type-aliases/QueryObserverResult.md | 2 +- docs/framework/lit/reference/type-aliases/QueryStatus.md | 2 +- docs/framework/lit/reference/type-aliases/ThrowOnError.md | 2 +- docs/framework/lit/reference/type-aliases/WithRequired.md | 2 +- .../framework/preact/reference/interfaces/CancelOptions.md | 2 +- .../preact/reference/interfaces/DefaultOptions.md | 2 +- .../preact/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../preact/reference/interfaces/FetchNextPageOptions.md | 2 +- .../reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../preact/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../preact/reference/interfaces/InitialPageParam.md | 6 +++--- .../preact/reference/interfaces/InvalidateOptions.md | 2 +- .../preact/reference/interfaces/InvalidateQueryFilters.md | 2 +- .../framework/preact/reference/interfaces/MutateOptions.md | 2 +- .../reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../preact/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- .../preact/reference/interfaces/MutationOptions.md | 2 +- docs/framework/preact/reference/interfaces/NotifyEvent.md | 2 +- .../preact/reference/interfaces/QueryClientConfig.md | 2 +- .../preact/reference/interfaces/QueryExecuteOptions.md | 2 +- .../preact/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../preact/reference/interfaces/QueryObserverOptions.md | 2 +- .../reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../reference/interfaces/QueryObserverSuccessResult.md | 2 +- .../preact/reference/interfaces/RefetchOptions.md | 2 +- .../preact/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/preact/reference/interfaces/ResetOptions.md | 2 +- .../framework/preact/reference/interfaces/ResultOptions.md | 2 +- .../preact/reference/interfaces/SetDataOptions.md | 2 +- .../preact/reference/interfaces/UseInfiniteQueryOptions.md | 2 +- .../interfaces/UseSuspenseInfiniteQueryOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../framework/preact/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../preact/reference/type-aliases/MutateFunction.md | 2 +- .../preact/reference/type-aliases/MutateFunctionRest.md | 2 +- .../preact/reference/type-aliases/MutationFunction.md | 2 +- .../reference/type-aliases/MutationFunctionContext.md | 2 +- .../framework/preact/reference/type-aliases/MutationKey.md | 2 +- .../preact/reference/type-aliases/MutationMeta.md | 2 +- .../reference/type-aliases/MutationObserverResult.md | 2 +- .../preact/reference/type-aliases/MutationScope.md | 2 +- .../preact/reference/type-aliases/MutationStatus.md | 2 +- .../preact/reference/type-aliases/NotifyEventType.md | 2 +- .../preact/reference/type-aliases/QueryObserverResult.md | 2 +- .../framework/preact/reference/type-aliases/QueryStatus.md | 2 +- .../preact/reference/type-aliases/ThrowOnError.md | 2 +- .../preact/reference/type-aliases/WithRequired.md | 2 +- docs/framework/react/reference/interfaces/CancelOptions.md | 2 +- .../framework/react/reference/interfaces/DefaultOptions.md | 2 +- .../react/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../react/reference/interfaces/FetchNextPageOptions.md | 2 +- .../react/reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../react/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../react/reference/interfaces/InitialPageParam.md | 6 +++--- .../react/reference/interfaces/InvalidateOptions.md | 2 +- .../react/reference/interfaces/InvalidateQueryFilters.md | 2 +- docs/framework/react/reference/interfaces/MutateOptions.md | 2 +- .../reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../react/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- .../react/reference/interfaces/MutationOptions.md | 2 +- docs/framework/react/reference/interfaces/NotifyEvent.md | 2 +- .../react/reference/interfaces/QueryClientConfig.md | 2 +- .../react/reference/interfaces/QueryExecuteOptions.md | 2 +- .../react/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../react/reference/interfaces/QueryObserverOptions.md | 2 +- .../reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../reference/interfaces/QueryObserverSuccessResult.md | 2 +- .../framework/react/reference/interfaces/RefetchOptions.md | 2 +- .../react/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/react/reference/interfaces/ResetOptions.md | 2 +- docs/framework/react/reference/interfaces/ResultOptions.md | 2 +- .../framework/react/reference/interfaces/SetDataOptions.md | 2 +- .../react/reference/interfaces/UseInfiniteQueryOptions.md | 2 +- .../interfaces/UseSuspenseInfiniteQueryOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- docs/framework/react/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../react/reference/type-aliases/MutateFunction.md | 2 +- .../react/reference/type-aliases/MutateFunctionRest.md | 2 +- .../react/reference/type-aliases/MutationFunction.md | 2 +- .../reference/type-aliases/MutationFunctionContext.md | 2 +- docs/framework/react/reference/type-aliases/MutationKey.md | 2 +- .../framework/react/reference/type-aliases/MutationMeta.md | 2 +- .../react/reference/type-aliases/MutationObserverResult.md | 2 +- .../react/reference/type-aliases/MutationScope.md | 2 +- .../react/reference/type-aliases/MutationStatus.md | 2 +- .../react/reference/type-aliases/NotifyEventType.md | 2 +- .../react/reference/type-aliases/QueryObserverResult.md | 2 +- docs/framework/react/reference/type-aliases/QueryStatus.md | 2 +- .../framework/react/reference/type-aliases/ThrowOnError.md | 2 +- .../framework/react/reference/type-aliases/WithRequired.md | 2 +- docs/framework/solid/reference/interfaces/CancelOptions.md | 2 +- .../solid/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../solid/reference/interfaces/FetchNextPageOptions.md | 2 +- .../solid/reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../solid/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 2 +- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../solid/reference/interfaces/InfiniteQueryOptions.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../solid/reference/interfaces/InitialPageParam.md | 6 +++--- .../solid/reference/interfaces/InvalidateOptions.md | 2 +- .../solid/reference/interfaces/InvalidateQueryFilters.md | 2 +- docs/framework/solid/reference/interfaces/MutateOptions.md | 2 +- .../reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../solid/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- docs/framework/solid/reference/interfaces/NotifyEvent.md | 2 +- .../solid/reference/interfaces/QueryExecuteOptions.md | 2 +- .../solid/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../reference/interfaces/QueryObserverSuccessResult.md | 2 +- .../framework/solid/reference/interfaces/RefetchOptions.md | 2 +- .../solid/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/solid/reference/interfaces/ResetOptions.md | 2 +- docs/framework/solid/reference/interfaces/ResultOptions.md | 2 +- .../framework/solid/reference/interfaces/SetDataOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- docs/framework/solid/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../solid/reference/type-aliases/MutateFunction.md | 2 +- .../solid/reference/type-aliases/MutateFunctionRest.md | 2 +- .../solid/reference/type-aliases/MutationFunction.md | 2 +- .../reference/type-aliases/MutationFunctionContext.md | 2 +- docs/framework/solid/reference/type-aliases/MutationKey.md | 2 +- .../framework/solid/reference/type-aliases/MutationMeta.md | 2 +- .../solid/reference/type-aliases/MutationObserverResult.md | 2 +- .../solid/reference/type-aliases/MutationScope.md | 2 +- .../solid/reference/type-aliases/MutationStatus.md | 2 +- .../solid/reference/type-aliases/NotifyEventType.md | 2 +- .../solid/reference/type-aliases/QueryObserverResult.md | 2 +- docs/framework/solid/reference/type-aliases/QueryStatus.md | 2 +- .../framework/solid/reference/type-aliases/ThrowOnError.md | 2 +- .../framework/solid/reference/type-aliases/WithRequired.md | 2 +- .../framework/svelte/reference/interfaces/CancelOptions.md | 2 +- .../svelte/reference/interfaces/DefaultOptions.md | 2 +- .../svelte/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../svelte/reference/interfaces/FetchNextPageOptions.md | 2 +- .../reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../svelte/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../svelte/reference/interfaces/InitialPageParam.md | 6 +++--- .../svelte/reference/interfaces/InvalidateOptions.md | 2 +- .../svelte/reference/interfaces/InvalidateQueryFilters.md | 2 +- .../framework/svelte/reference/interfaces/MutateOptions.md | 2 +- .../reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../svelte/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- .../svelte/reference/interfaces/MutationOptions.md | 2 +- docs/framework/svelte/reference/interfaces/NotifyEvent.md | 2 +- .../svelte/reference/interfaces/QueryClientConfig.md | 2 +- .../svelte/reference/interfaces/QueryExecuteOptions.md | 2 +- .../svelte/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../svelte/reference/interfaces/QueryObserverOptions.md | 2 +- .../reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../reference/interfaces/QueryObserverSuccessResult.md | 2 +- .../svelte/reference/interfaces/RefetchOptions.md | 2 +- .../svelte/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/svelte/reference/interfaces/ResetOptions.md | 2 +- .../framework/svelte/reference/interfaces/ResultOptions.md | 2 +- .../svelte/reference/interfaces/SetDataOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../framework/svelte/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../svelte/reference/type-aliases/MutateFunction.md | 2 +- .../svelte/reference/type-aliases/MutateFunctionRest.md | 2 +- .../svelte/reference/type-aliases/MutationFunction.md | 2 +- .../reference/type-aliases/MutationFunctionContext.md | 2 +- .../framework/svelte/reference/type-aliases/MutationKey.md | 2 +- .../svelte/reference/type-aliases/MutationMeta.md | 2 +- .../reference/type-aliases/MutationObserverResult.md | 2 +- .../svelte/reference/type-aliases/MutationScope.md | 2 +- .../svelte/reference/type-aliases/MutationStatus.md | 2 +- .../svelte/reference/type-aliases/NotifyEventType.md | 2 +- .../svelte/reference/type-aliases/QueryObserverResult.md | 2 +- .../framework/svelte/reference/type-aliases/QueryStatus.md | 2 +- .../svelte/reference/type-aliases/ThrowOnError.md | 2 +- .../svelte/reference/type-aliases/WithRequired.md | 2 +- docs/framework/vue/reference/interfaces/CancelOptions.md | 2 +- docs/framework/vue/reference/interfaces/DefaultOptions.md | 2 +- .../vue/reference/interfaces/EnsureQueryDataOptions.md | 2 +- .../vue/reference/interfaces/FetchNextPageOptions.md | 2 +- .../vue/reference/interfaces/FetchPreviousPageOptions.md | 2 +- .../vue/reference/interfaces/FetchQueryOptions.md | 2 +- .../interfaces/InfiniteQueryObserverBaseResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverLoadingResult.md | 2 +- .../reference/interfaces/InfiniteQueryObserverOptions.md | 4 ++-- .../interfaces/InfiniteQueryObserverPendingResult.md | 2 +- .../interfaces/InfiniteQueryObserverPlaceholderResult.md | 2 +- .../interfaces/InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../interfaces/InfiniteQueryObserverSuccessResult.md | 2 +- .../reference/interfaces/InfiniteQueryPageParamsOptions.md | 4 ++-- .../framework/vue/reference/interfaces/InitialPageParam.md | 6 +++--- .../vue/reference/interfaces/InvalidateOptions.md | 2 +- .../vue/reference/interfaces/InvalidateQueryFilters.md | 2 +- docs/framework/vue/reference/interfaces/MutateOptions.md | 2 +- .../vue/reference/interfaces/MutationObserverBaseResult.md | 2 +- .../reference/interfaces/MutationObserverErrorResult.md | 2 +- .../vue/reference/interfaces/MutationObserverIdleResult.md | 2 +- .../reference/interfaces/MutationObserverLoadingResult.md | 2 +- .../vue/reference/interfaces/MutationObserverOptions.md | 2 +- .../reference/interfaces/MutationObserverSuccessResult.md | 2 +- docs/framework/vue/reference/interfaces/NotifyEvent.md | 2 +- .../vue/reference/interfaces/QueryClientConfig.md | 2 +- .../vue/reference/interfaces/QueryExecuteOptions.md | 2 +- .../vue/reference/interfaces/QueryObserverBaseResult.md | 2 +- .../interfaces/QueryObserverLoadingErrorResult.md | 2 +- .../vue/reference/interfaces/QueryObserverLoadingResult.md | 2 +- .../vue/reference/interfaces/QueryObserverOptions.md | 2 +- .../vue/reference/interfaces/QueryObserverPendingResult.md | 2 +- .../reference/interfaces/QueryObserverPlaceholderResult.md | 2 +- .../interfaces/QueryObserverRefetchErrorResult.md | 2 +- .../vue/reference/interfaces/QueryObserverSuccessResult.md | 2 +- docs/framework/vue/reference/interfaces/RefetchOptions.md | 2 +- .../vue/reference/interfaces/RefetchQueryFilters.md | 2 +- docs/framework/vue/reference/interfaces/ResetOptions.md | 2 +- docs/framework/vue/reference/interfaces/ResultOptions.md | 2 +- docs/framework/vue/reference/interfaces/SetDataOptions.md | 2 +- .../type-aliases/DefaultedInfiniteQueryObserverOptions.md | 2 +- .../type-aliases/DefaultedQueryObserverOptions.md | 2 +- .../type-aliases/DefinedInfiniteQueryObserverResult.md | 2 +- .../reference/type-aliases/DefinedQueryObserverResult.md | 2 +- .../type-aliases/EnsureInfiniteQueryDataOptions.md | 2 +- .../reference/type-aliases/FetchInfiniteQueryOptions.md | 2 +- docs/framework/vue/reference/type-aliases/FetchStatus.md | 2 +- .../reference/type-aliases/InfiniteQueryExecuteOptions.md | 2 +- .../reference/type-aliases/InfiniteQueryObserverResult.md | 2 +- .../framework/vue/reference/type-aliases/MutateFunction.md | 2 +- .../vue/reference/type-aliases/MutateFunctionRest.md | 2 +- .../vue/reference/type-aliases/MutationFunction.md | 2 +- .../vue/reference/type-aliases/MutationFunctionContext.md | 2 +- docs/framework/vue/reference/type-aliases/MutationKey.md | 2 +- docs/framework/vue/reference/type-aliases/MutationMeta.md | 2 +- .../vue/reference/type-aliases/MutationObserverResult.md | 2 +- docs/framework/vue/reference/type-aliases/MutationScope.md | 2 +- .../framework/vue/reference/type-aliases/MutationStatus.md | 2 +- .../vue/reference/type-aliases/NotifyEventType.md | 2 +- .../vue/reference/type-aliases/QueryObserverResult.md | 2 +- docs/framework/vue/reference/type-aliases/QueryStatus.md | 2 +- docs/framework/vue/reference/type-aliases/ThrowOnError.md | 2 +- docs/framework/vue/reference/type-aliases/WithRequired.md | 2 +- packages/query-core/src/types.ts | 7 +++++++ 457 files changed, 490 insertions(+), 483 deletions(-) diff --git a/docs/framework/angular/reference/interfaces/CancelOptions.md b/docs/framework/angular/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/angular/reference/interfaces/CancelOptions.md +++ b/docs/framework/angular/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md b/docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md index 615ae86728..e4c7351f41 100644 --- a/docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md +++ b/docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md @@ -58,7 +58,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/angular/reference/interfaces/DefaultOptions.md b/docs/framework/angular/reference/interfaces/DefaultOptions.md index e17c6a0f67..4124204e04 100644 --- a/docs/framework/angular/reference/interfaces/DefaultOptions.md +++ b/docs/framework/angular/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md b/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/angular/reference/interfaces/FetchQueryOptions.md b/docs/framework/angular/reference/interfaces/FetchQueryOptions.md index a8b0b8d6c5..ca3c25500f 100644 --- a/docs/framework/angular/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/angular/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/angular/reference/interfaces/InitialPageParam.md b/docs/framework/angular/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/angular/reference/interfaces/InitialPageParam.md +++ b/docs/framework/angular/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/angular/reference/interfaces/InvalidateOptions.md b/docs/framework/angular/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/angular/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/angular/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/angular/reference/interfaces/MutateOptions.md b/docs/framework/angular/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/angular/reference/interfaces/MutateOptions.md +++ b/docs/framework/angular/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/angular/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/angular/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/angular/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/angular/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/angular/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/angular/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/angular/reference/interfaces/MutationObserverOptions.md b/docs/framework/angular/reference/interfaces/MutationObserverOptions.md index 30faeb150d..7c84660e7b 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/angular/reference/interfaces/MutationOptions.md b/docs/framework/angular/reference/interfaces/MutationOptions.md index 46014c6ae7..40e2a1ffe3 100644 --- a/docs/framework/angular/reference/interfaces/MutationOptions.md +++ b/docs/framework/angular/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218) +Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/NotifyEvent.md b/docs/framework/angular/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/angular/reference/interfaces/NotifyEvent.md +++ b/docs/framework/angular/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/angular/reference/interfaces/QueryClientConfig.md b/docs/framework/angular/reference/interfaces/QueryClientConfig.md index fe1814c346..65cc5c4bce 100644 --- a/docs/framework/angular/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/angular/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md b/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md index e5366a4939..11a3860d80 100644 --- a/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverOptions.md b/docs/framework/angular/reference/interfaces/QueryObserverOptions.md index bd72b554a1..291eea1dbb 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/angular/reference/interfaces/RefetchOptions.md b/docs/framework/angular/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/angular/reference/interfaces/RefetchOptions.md +++ b/docs/framework/angular/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md b/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/angular/reference/interfaces/ResetOptions.md b/docs/framework/angular/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/angular/reference/interfaces/ResetOptions.md +++ b/docs/framework/angular/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/angular/reference/interfaces/ResultOptions.md b/docs/framework/angular/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/angular/reference/interfaces/ResultOptions.md +++ b/docs/framework/angular/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/SetDataOptions.md b/docs/framework/angular/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/angular/reference/interfaces/SetDataOptions.md +++ b/docs/framework/angular/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/FetchStatus.md b/docs/framework/angular/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/angular/reference/type-aliases/FetchStatus.md +++ b/docs/framework/angular/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutateFunction.md b/docs/framework/angular/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/angular/reference/type-aliases/MutateFunction.md +++ b/docs/framework/angular/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md b/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationFunction.md b/docs/framework/angular/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/angular/reference/type-aliases/MutationFunction.md +++ b/docs/framework/angular/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md b/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md index 11b4d93781..74c4e935c7 100644 --- a/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/angular/reference/type-aliases/MutationKey.md b/docs/framework/angular/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/angular/reference/type-aliases/MutationKey.md +++ b/docs/framework/angular/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/angular/reference/type-aliases/MutationMeta.md b/docs/framework/angular/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/angular/reference/type-aliases/MutationMeta.md +++ b/docs/framework/angular/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/angular/reference/type-aliases/MutationObserverResult.md b/docs/framework/angular/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/angular/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/angular/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationScope.md b/docs/framework/angular/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/angular/reference/type-aliases/MutationScope.md +++ b/docs/framework/angular/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/angular/reference/type-aliases/MutationStatus.md b/docs/framework/angular/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/angular/reference/type-aliases/MutationStatus.md +++ b/docs/framework/angular/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/angular/reference/type-aliases/NotifyEventType.md b/docs/framework/angular/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/angular/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/angular/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/angular/reference/type-aliases/QueryObserverResult.md b/docs/framework/angular/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/angular/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/angular/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryStatus.md b/docs/framework/angular/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/angular/reference/type-aliases/QueryStatus.md +++ b/docs/framework/angular/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/angular/reference/type-aliases/ThrowOnError.md b/docs/framework/angular/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/angular/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/angular/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/WithRequired.md b/docs/framework/angular/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/angular/reference/type-aliases/WithRequired.md +++ b/docs/framework/angular/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/CancelOptions.md b/docs/framework/lit/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/lit/reference/interfaces/CancelOptions.md +++ b/docs/framework/lit/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/lit/reference/interfaces/DefaultOptions.md b/docs/framework/lit/reference/interfaces/DefaultOptions.md index e17c6a0f67..4124204e04 100644 --- a/docs/framework/lit/reference/interfaces/DefaultOptions.md +++ b/docs/framework/lit/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md b/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/lit/reference/interfaces/FetchQueryOptions.md b/docs/framework/lit/reference/interfaces/FetchQueryOptions.md index a8b0b8d6c5..ca3c25500f 100644 --- a/docs/framework/lit/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/lit/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/lit/reference/interfaces/InitialPageParam.md b/docs/framework/lit/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/lit/reference/interfaces/InitialPageParam.md +++ b/docs/framework/lit/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/lit/reference/interfaces/InvalidateOptions.md b/docs/framework/lit/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/lit/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/lit/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/lit/reference/interfaces/MutateOptions.md b/docs/framework/lit/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/lit/reference/interfaces/MutateOptions.md +++ b/docs/framework/lit/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/lit/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/lit/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/lit/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/lit/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/lit/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/lit/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/lit/reference/interfaces/MutationObserverOptions.md b/docs/framework/lit/reference/interfaces/MutationObserverOptions.md index 30faeb150d..7c84660e7b 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/lit/reference/interfaces/MutationOptions.md b/docs/framework/lit/reference/interfaces/MutationOptions.md index 46014c6ae7..40e2a1ffe3 100644 --- a/docs/framework/lit/reference/interfaces/MutationOptions.md +++ b/docs/framework/lit/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218) +Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/NotifyEvent.md b/docs/framework/lit/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/lit/reference/interfaces/NotifyEvent.md +++ b/docs/framework/lit/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/lit/reference/interfaces/QueryClientConfig.md b/docs/framework/lit/reference/interfaces/QueryClientConfig.md index fe1814c346..65cc5c4bce 100644 --- a/docs/framework/lit/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/lit/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md b/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md index e5366a4939..11a3860d80 100644 --- a/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverOptions.md b/docs/framework/lit/reference/interfaces/QueryObserverOptions.md index 1ccbe4be8f..d57f0e4b80 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/lit/reference/interfaces/RefetchOptions.md b/docs/framework/lit/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/lit/reference/interfaces/RefetchOptions.md +++ b/docs/framework/lit/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md b/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/lit/reference/interfaces/ResetOptions.md b/docs/framework/lit/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/lit/reference/interfaces/ResetOptions.md +++ b/docs/framework/lit/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/lit/reference/interfaces/ResultOptions.md b/docs/framework/lit/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/lit/reference/interfaces/ResultOptions.md +++ b/docs/framework/lit/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/SetDataOptions.md b/docs/framework/lit/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/lit/reference/interfaces/SetDataOptions.md +++ b/docs/framework/lit/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 68f00e9d66..82087de0eb 100644 --- a/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md index 98063af8ac..7ac10bb8df 100644 --- a/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FetchStatus.md b/docs/framework/lit/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/lit/reference/type-aliases/FetchStatus.md +++ b/docs/framework/lit/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md index 06e88676d8..cd7e918e31 100644 --- a/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutateFunction.md b/docs/framework/lit/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/lit/reference/type-aliases/MutateFunction.md +++ b/docs/framework/lit/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md b/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationFunction.md b/docs/framework/lit/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/lit/reference/type-aliases/MutationFunction.md +++ b/docs/framework/lit/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md b/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md index 11b4d93781..74c4e935c7 100644 --- a/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/lit/reference/type-aliases/MutationKey.md b/docs/framework/lit/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/lit/reference/type-aliases/MutationKey.md +++ b/docs/framework/lit/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/lit/reference/type-aliases/MutationMeta.md b/docs/framework/lit/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/lit/reference/type-aliases/MutationMeta.md +++ b/docs/framework/lit/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/lit/reference/type-aliases/MutationObserverResult.md b/docs/framework/lit/reference/type-aliases/MutationObserverResult.md index f72a5c52ae..acf0c2062c 100644 --- a/docs/framework/lit/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/lit/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationScope.md b/docs/framework/lit/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/lit/reference/type-aliases/MutationScope.md +++ b/docs/framework/lit/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/lit/reference/type-aliases/MutationStatus.md b/docs/framework/lit/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/lit/reference/type-aliases/MutationStatus.md +++ b/docs/framework/lit/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/lit/reference/type-aliases/NotifyEventType.md b/docs/framework/lit/reference/type-aliases/NotifyEventType.md index 90d7f679aa..2c6bac81ba 100644 --- a/docs/framework/lit/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/lit/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/lit/reference/type-aliases/QueryObserverResult.md b/docs/framework/lit/reference/type-aliases/QueryObserverResult.md index 03bf7dbf9e..ca4f316226 100644 --- a/docs/framework/lit/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/lit/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryStatus.md b/docs/framework/lit/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/lit/reference/type-aliases/QueryStatus.md +++ b/docs/framework/lit/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/lit/reference/type-aliases/ThrowOnError.md b/docs/framework/lit/reference/type-aliases/ThrowOnError.md index 55f21b2378..a3d58bb792 100644 --- a/docs/framework/lit/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/lit/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/WithRequired.md b/docs/framework/lit/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/lit/reference/type-aliases/WithRequired.md +++ b/docs/framework/lit/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/CancelOptions.md b/docs/framework/preact/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/preact/reference/interfaces/CancelOptions.md +++ b/docs/framework/preact/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/preact/reference/interfaces/DefaultOptions.md b/docs/framework/preact/reference/interfaces/DefaultOptions.md index e17c6a0f67..4124204e04 100644 --- a/docs/framework/preact/reference/interfaces/DefaultOptions.md +++ b/docs/framework/preact/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md b/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/preact/reference/interfaces/FetchQueryOptions.md b/docs/framework/preact/reference/interfaces/FetchQueryOptions.md index a8b0b8d6c5..ca3c25500f 100644 --- a/docs/framework/preact/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/preact/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/preact/reference/interfaces/InitialPageParam.md b/docs/framework/preact/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/preact/reference/interfaces/InitialPageParam.md +++ b/docs/framework/preact/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/preact/reference/interfaces/InvalidateOptions.md b/docs/framework/preact/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/preact/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/preact/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/preact/reference/interfaces/MutateOptions.md b/docs/framework/preact/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/preact/reference/interfaces/MutateOptions.md +++ b/docs/framework/preact/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/preact/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/preact/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/preact/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/preact/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/preact/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/preact/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/preact/reference/interfaces/MutationObserverOptions.md b/docs/framework/preact/reference/interfaces/MutationObserverOptions.md index 30faeb150d..7c84660e7b 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/preact/reference/interfaces/MutationOptions.md b/docs/framework/preact/reference/interfaces/MutationOptions.md index 46014c6ae7..40e2a1ffe3 100644 --- a/docs/framework/preact/reference/interfaces/MutationOptions.md +++ b/docs/framework/preact/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218) +Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/NotifyEvent.md b/docs/framework/preact/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/preact/reference/interfaces/NotifyEvent.md +++ b/docs/framework/preact/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/preact/reference/interfaces/QueryClientConfig.md b/docs/framework/preact/reference/interfaces/QueryClientConfig.md index fe1814c346..65cc5c4bce 100644 --- a/docs/framework/preact/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/preact/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md b/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md index e5366a4939..11a3860d80 100644 --- a/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverOptions.md b/docs/framework/preact/reference/interfaces/QueryObserverOptions.md index 45c2550f48..f2b31e1bf1 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/preact/reference/interfaces/RefetchOptions.md b/docs/framework/preact/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/preact/reference/interfaces/RefetchOptions.md +++ b/docs/framework/preact/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md b/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/preact/reference/interfaces/ResetOptions.md b/docs/framework/preact/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/preact/reference/interfaces/ResetOptions.md +++ b/docs/framework/preact/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/preact/reference/interfaces/ResultOptions.md b/docs/framework/preact/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/preact/reference/interfaces/ResultOptions.md +++ b/docs/framework/preact/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/SetDataOptions.md b/docs/framework/preact/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/preact/reference/interfaces/SetDataOptions.md +++ b/docs/framework/preact/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md b/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md index 31aca8181b..25110768d1 100644 --- a/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md +++ b/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md @@ -56,7 +56,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md b/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md index 4caef8a73f..8b2f6e24a9 100644 --- a/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md @@ -55,7 +55,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FetchStatus.md b/docs/framework/preact/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/preact/reference/type-aliases/FetchStatus.md +++ b/docs/framework/preact/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutateFunction.md b/docs/framework/preact/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/preact/reference/type-aliases/MutateFunction.md +++ b/docs/framework/preact/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md b/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationFunction.md b/docs/framework/preact/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/preact/reference/type-aliases/MutationFunction.md +++ b/docs/framework/preact/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md b/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md index 11b4d93781..74c4e935c7 100644 --- a/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/preact/reference/type-aliases/MutationKey.md b/docs/framework/preact/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/preact/reference/type-aliases/MutationKey.md +++ b/docs/framework/preact/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/preact/reference/type-aliases/MutationMeta.md b/docs/framework/preact/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/preact/reference/type-aliases/MutationMeta.md +++ b/docs/framework/preact/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/preact/reference/type-aliases/MutationObserverResult.md b/docs/framework/preact/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/preact/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/preact/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationScope.md b/docs/framework/preact/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/preact/reference/type-aliases/MutationScope.md +++ b/docs/framework/preact/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/preact/reference/type-aliases/MutationStatus.md b/docs/framework/preact/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/preact/reference/type-aliases/MutationStatus.md +++ b/docs/framework/preact/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/preact/reference/type-aliases/NotifyEventType.md b/docs/framework/preact/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/preact/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/preact/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/preact/reference/type-aliases/QueryObserverResult.md b/docs/framework/preact/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/preact/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/preact/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryStatus.md b/docs/framework/preact/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/preact/reference/type-aliases/QueryStatus.md +++ b/docs/framework/preact/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/preact/reference/type-aliases/ThrowOnError.md b/docs/framework/preact/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/preact/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/preact/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/WithRequired.md b/docs/framework/preact/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/preact/reference/type-aliases/WithRequired.md +++ b/docs/framework/preact/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/CancelOptions.md b/docs/framework/react/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/react/reference/interfaces/CancelOptions.md +++ b/docs/framework/react/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/react/reference/interfaces/DefaultOptions.md b/docs/framework/react/reference/interfaces/DefaultOptions.md index e17c6a0f67..4124204e04 100644 --- a/docs/framework/react/reference/interfaces/DefaultOptions.md +++ b/docs/framework/react/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/react/reference/interfaces/FetchNextPageOptions.md b/docs/framework/react/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/react/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/react/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/react/reference/interfaces/FetchQueryOptions.md b/docs/framework/react/reference/interfaces/FetchQueryOptions.md index a8b0b8d6c5..ca3c25500f 100644 --- a/docs/framework/react/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/react/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/react/reference/interfaces/InitialPageParam.md b/docs/framework/react/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/react/reference/interfaces/InitialPageParam.md +++ b/docs/framework/react/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/react/reference/interfaces/InvalidateOptions.md b/docs/framework/react/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/react/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/react/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/react/reference/interfaces/MutateOptions.md b/docs/framework/react/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/react/reference/interfaces/MutateOptions.md +++ b/docs/framework/react/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/react/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/react/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/react/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/react/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/react/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/react/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/react/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/react/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/react/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/react/reference/interfaces/MutationObserverOptions.md b/docs/framework/react/reference/interfaces/MutationObserverOptions.md index 30faeb150d..7c84660e7b 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/react/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/react/reference/interfaces/MutationOptions.md b/docs/framework/react/reference/interfaces/MutationOptions.md index 46014c6ae7..40e2a1ffe3 100644 --- a/docs/framework/react/reference/interfaces/MutationOptions.md +++ b/docs/framework/react/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218) +Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) ## Extended by diff --git a/docs/framework/react/reference/interfaces/NotifyEvent.md b/docs/framework/react/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/react/reference/interfaces/NotifyEvent.md +++ b/docs/framework/react/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/react/reference/interfaces/QueryClientConfig.md b/docs/framework/react/reference/interfaces/QueryClientConfig.md index fe1814c346..65cc5c4bce 100644 --- a/docs/framework/react/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/react/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/react/reference/interfaces/QueryExecuteOptions.md b/docs/framework/react/reference/interfaces/QueryExecuteOptions.md index e5366a4939..11a3860d80 100644 --- a/docs/framework/react/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/react/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverOptions.md b/docs/framework/react/reference/interfaces/QueryObserverOptions.md index 45c2550f48..f2b31e1bf1 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/react/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/react/reference/interfaces/RefetchOptions.md b/docs/framework/react/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/react/reference/interfaces/RefetchOptions.md +++ b/docs/framework/react/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/react/reference/interfaces/RefetchQueryFilters.md b/docs/framework/react/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/react/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/react/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/react/reference/interfaces/ResetOptions.md b/docs/framework/react/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/react/reference/interfaces/ResetOptions.md +++ b/docs/framework/react/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/react/reference/interfaces/ResultOptions.md b/docs/framework/react/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/react/reference/interfaces/ResultOptions.md +++ b/docs/framework/react/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/react/reference/interfaces/SetDataOptions.md b/docs/framework/react/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/react/reference/interfaces/SetDataOptions.md +++ b/docs/framework/react/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/react/reference/interfaces/UseInfiniteQueryOptions.md b/docs/framework/react/reference/interfaces/UseInfiniteQueryOptions.md index 86737eea86..8f9eed9aa3 100644 --- a/docs/framework/react/reference/interfaces/UseInfiniteQueryOptions.md +++ b/docs/framework/react/reference/interfaces/UseInfiniteQueryOptions.md @@ -56,7 +56,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/react/reference/interfaces/UseSuspenseInfiniteQueryOptions.md b/docs/framework/react/reference/interfaces/UseSuspenseInfiniteQueryOptions.md index fe83489042..baebb01ff5 100644 --- a/docs/framework/react/reference/interfaces/UseSuspenseInfiniteQueryOptions.md +++ b/docs/framework/react/reference/interfaces/UseSuspenseInfiniteQueryOptions.md @@ -55,7 +55,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FetchStatus.md b/docs/framework/react/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/react/reference/type-aliases/FetchStatus.md +++ b/docs/framework/react/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutateFunction.md b/docs/framework/react/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/react/reference/type-aliases/MutateFunction.md +++ b/docs/framework/react/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutateFunctionRest.md b/docs/framework/react/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/react/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/react/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationFunction.md b/docs/framework/react/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/react/reference/type-aliases/MutationFunction.md +++ b/docs/framework/react/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationFunctionContext.md b/docs/framework/react/reference/type-aliases/MutationFunctionContext.md index 11b4d93781..74c4e935c7 100644 --- a/docs/framework/react/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/react/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/react/reference/type-aliases/MutationKey.md b/docs/framework/react/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/react/reference/type-aliases/MutationKey.md +++ b/docs/framework/react/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/react/reference/type-aliases/MutationMeta.md b/docs/framework/react/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/react/reference/type-aliases/MutationMeta.md +++ b/docs/framework/react/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/react/reference/type-aliases/MutationObserverResult.md b/docs/framework/react/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/react/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/react/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationScope.md b/docs/framework/react/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/react/reference/type-aliases/MutationScope.md +++ b/docs/framework/react/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/react/reference/type-aliases/MutationStatus.md b/docs/framework/react/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/react/reference/type-aliases/MutationStatus.md +++ b/docs/framework/react/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/react/reference/type-aliases/NotifyEventType.md b/docs/framework/react/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/react/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/react/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/react/reference/type-aliases/QueryObserverResult.md b/docs/framework/react/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/react/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/react/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryStatus.md b/docs/framework/react/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/react/reference/type-aliases/QueryStatus.md +++ b/docs/framework/react/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/react/reference/type-aliases/ThrowOnError.md b/docs/framework/react/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/react/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/react/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/WithRequired.md b/docs/framework/react/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/react/reference/type-aliases/WithRequired.md +++ b/docs/framework/react/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/CancelOptions.md b/docs/framework/solid/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/solid/reference/interfaces/CancelOptions.md +++ b/docs/framework/solid/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md b/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/solid/reference/interfaces/FetchQueryOptions.md b/docs/framework/solid/reference/interfaces/FetchQueryOptions.md index bc0dcf0946..53681702fa 100644 --- a/docs/framework/solid/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/solid/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverOptions.md index 7b41540b9e..03469fe65e 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverOptions.md @@ -53,7 +53,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md b/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md index a4fd6b51d7..04319f7768 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md @@ -54,7 +54,7 @@ The type of the parameter passed to `queryFn` to fetch a given page. | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md index 5aefade05d..355fc48ec9 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -25,4 +25,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/solid/reference/interfaces/InitialPageParam.md b/docs/framework/solid/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/solid/reference/interfaces/InitialPageParam.md +++ b/docs/framework/solid/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/solid/reference/interfaces/InvalidateOptions.md b/docs/framework/solid/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/solid/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/solid/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/solid/reference/interfaces/MutateOptions.md b/docs/framework/solid/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/solid/reference/interfaces/MutateOptions.md +++ b/docs/framework/solid/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/solid/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/solid/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/solid/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/solid/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/solid/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/solid/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/solid/reference/interfaces/MutationObserverOptions.md b/docs/framework/solid/reference/interfaces/MutationObserverOptions.md index 30f1025de9..0e1022e421 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/solid/reference/interfaces/NotifyEvent.md b/docs/framework/solid/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/solid/reference/interfaces/NotifyEvent.md +++ b/docs/framework/solid/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md b/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md index d702d5a779..47891676ea 100644 --- a/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/solid/reference/interfaces/RefetchOptions.md b/docs/framework/solid/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/solid/reference/interfaces/RefetchOptions.md +++ b/docs/framework/solid/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md b/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/solid/reference/interfaces/ResetOptions.md b/docs/framework/solid/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/solid/reference/interfaces/ResetOptions.md +++ b/docs/framework/solid/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/solid/reference/interfaces/ResultOptions.md b/docs/framework/solid/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/solid/reference/interfaces/ResultOptions.md +++ b/docs/framework/solid/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/solid/reference/interfaces/SetDataOptions.md b/docs/framework/solid/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/solid/reference/interfaces/SetDataOptions.md +++ b/docs/framework/solid/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FetchStatus.md b/docs/framework/solid/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/solid/reference/type-aliases/FetchStatus.md +++ b/docs/framework/solid/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutateFunction.md b/docs/framework/solid/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/solid/reference/type-aliases/MutateFunction.md +++ b/docs/framework/solid/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md b/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationFunction.md b/docs/framework/solid/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/solid/reference/type-aliases/MutationFunction.md +++ b/docs/framework/solid/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md b/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md index b415353dab..07574115fc 100644 --- a/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/solid/reference/type-aliases/MutationKey.md b/docs/framework/solid/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/solid/reference/type-aliases/MutationKey.md +++ b/docs/framework/solid/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/solid/reference/type-aliases/MutationMeta.md b/docs/framework/solid/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/solid/reference/type-aliases/MutationMeta.md +++ b/docs/framework/solid/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/solid/reference/type-aliases/MutationObserverResult.md b/docs/framework/solid/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/solid/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/solid/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationScope.md b/docs/framework/solid/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/solid/reference/type-aliases/MutationScope.md +++ b/docs/framework/solid/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/solid/reference/type-aliases/MutationStatus.md b/docs/framework/solid/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/solid/reference/type-aliases/MutationStatus.md +++ b/docs/framework/solid/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/solid/reference/type-aliases/NotifyEventType.md b/docs/framework/solid/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/solid/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/solid/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/solid/reference/type-aliases/QueryObserverResult.md b/docs/framework/solid/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/solid/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/solid/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryStatus.md b/docs/framework/solid/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/solid/reference/type-aliases/QueryStatus.md +++ b/docs/framework/solid/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/solid/reference/type-aliases/ThrowOnError.md b/docs/framework/solid/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/solid/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/solid/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/WithRequired.md b/docs/framework/solid/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/solid/reference/type-aliases/WithRequired.md +++ b/docs/framework/solid/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/CancelOptions.md b/docs/framework/svelte/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/svelte/reference/interfaces/CancelOptions.md +++ b/docs/framework/svelte/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/DefaultOptions.md b/docs/framework/svelte/reference/interfaces/DefaultOptions.md index e17c6a0f67..4124204e04 100644 --- a/docs/framework/svelte/reference/interfaces/DefaultOptions.md +++ b/docs/framework/svelte/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md b/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md b/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md index a8b0b8d6c5..ca3c25500f 100644 --- a/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/svelte/reference/interfaces/InitialPageParam.md b/docs/framework/svelte/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/svelte/reference/interfaces/InitialPageParam.md +++ b/docs/framework/svelte/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/svelte/reference/interfaces/InvalidateOptions.md b/docs/framework/svelte/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/svelte/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/svelte/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/svelte/reference/interfaces/MutateOptions.md b/docs/framework/svelte/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/svelte/reference/interfaces/MutateOptions.md +++ b/docs/framework/svelte/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverOptions.md b/docs/framework/svelte/reference/interfaces/MutationObserverOptions.md index 30faeb150d..7c84660e7b 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/svelte/reference/interfaces/MutationOptions.md b/docs/framework/svelte/reference/interfaces/MutationOptions.md index 46014c6ae7..40e2a1ffe3 100644 --- a/docs/framework/svelte/reference/interfaces/MutationOptions.md +++ b/docs/framework/svelte/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/query-core/src/types.ts:1218](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1218) +Defined in: [packages/query-core/src/types.ts:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/NotifyEvent.md b/docs/framework/svelte/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/svelte/reference/interfaces/NotifyEvent.md +++ b/docs/framework/svelte/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/QueryClientConfig.md b/docs/framework/svelte/reference/interfaces/QueryClientConfig.md index fe1814c346..65cc5c4bce 100644 --- a/docs/framework/svelte/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/svelte/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md b/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md index e5366a4939..11a3860d80 100644 --- a/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md b/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md index 1ccbe4be8f..d57f0e4b80 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/RefetchOptions.md b/docs/framework/svelte/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/svelte/reference/interfaces/RefetchOptions.md +++ b/docs/framework/svelte/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md b/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/svelte/reference/interfaces/ResetOptions.md b/docs/framework/svelte/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/svelte/reference/interfaces/ResetOptions.md +++ b/docs/framework/svelte/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/ResultOptions.md b/docs/framework/svelte/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/svelte/reference/interfaces/ResultOptions.md +++ b/docs/framework/svelte/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/SetDataOptions.md b/docs/framework/svelte/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/svelte/reference/interfaces/SetDataOptions.md +++ b/docs/framework/svelte/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FetchStatus.md b/docs/framework/svelte/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/svelte/reference/type-aliases/FetchStatus.md +++ b/docs/framework/svelte/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutateFunction.md b/docs/framework/svelte/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/svelte/reference/type-aliases/MutateFunction.md +++ b/docs/framework/svelte/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md b/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationFunction.md b/docs/framework/svelte/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationFunction.md +++ b/docs/framework/svelte/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md b/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md index 11b4d93781..74c4e935c7 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/MutationKey.md b/docs/framework/svelte/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationKey.md +++ b/docs/framework/svelte/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/svelte/reference/type-aliases/MutationMeta.md b/docs/framework/svelte/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationMeta.md +++ b/docs/framework/svelte/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md b/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationScope.md b/docs/framework/svelte/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationScope.md +++ b/docs/framework/svelte/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/MutationStatus.md b/docs/framework/svelte/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationStatus.md +++ b/docs/framework/svelte/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/svelte/reference/type-aliases/NotifyEventType.md b/docs/framework/svelte/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/svelte/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/svelte/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryStatus.md b/docs/framework/svelte/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryStatus.md +++ b/docs/framework/svelte/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/svelte/reference/type-aliases/ThrowOnError.md b/docs/framework/svelte/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/svelte/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/svelte/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/WithRequired.md b/docs/framework/svelte/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/svelte/reference/type-aliases/WithRequired.md +++ b/docs/framework/svelte/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/CancelOptions.md b/docs/framework/vue/reference/interfaces/CancelOptions.md index 254899ad9e..83eef7f40d 100644 --- a/docs/framework/vue/reference/interfaces/CancelOptions.md +++ b/docs/framework/vue/reference/interfaces/CancelOptions.md @@ -3,7 +3,7 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1582](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1582) +Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) ## Properties diff --git a/docs/framework/vue/reference/interfaces/DefaultOptions.md b/docs/framework/vue/reference/interfaces/DefaultOptions.md index 5232eb986f..c5a4cca9d3 100644 --- a/docs/framework/vue/reference/interfaces/DefaultOptions.md +++ b/docs/framework/vue/reference/interfaces/DefaultOptions.md @@ -3,7 +3,7 @@ id: DefaultOptions title: DefaultOptions --- -Defined in: [packages/query-core/src/types.ts:1568](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1568) +Defined in: [packages/query-core/src/types.ts:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md index 28429ab5a7..495860f19a 100644 --- a/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md +++ b/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md @@ -3,7 +3,7 @@ id: EnsureQueryDataOptions title: EnsureQueryDataOptions --- -Defined in: [packages/query-core/src/types.ts:627](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L627) +Defined in: [packages/query-core/src/types.ts:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) ## Deprecated diff --git a/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md b/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md index cc37217a82..906ecf7e7b 100644 --- a/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md +++ b/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md @@ -3,7 +3,7 @@ id: FetchNextPageOptions title: FetchNextPageOptions --- -Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) ## Extends diff --git a/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md index c9f26f065a..67e134be01 100644 --- a/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md +++ b/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md @@ -3,7 +3,7 @@ id: FetchPreviousPageOptions title: FetchPreviousPageOptions --- -Defined in: [packages/query-core/src/types.ts:763](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L763) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) ## Extends diff --git a/docs/framework/vue/reference/interfaces/FetchQueryOptions.md b/docs/framework/vue/reference/interfaces/FetchQueryOptions.md index bc0dcf0946..53681702fa 100644 --- a/docs/framework/vue/reference/interfaces/FetchQueryOptions.md +++ b/docs/framework/vue/reference/interfaces/FetchQueryOptions.md @@ -3,7 +3,7 @@ id: FetchQueryOptions title: FetchQueryOptions --- -Defined in: [packages/query-core/src/types.ts:608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L608) +Defined in: [packages/query-core/src/types.ts:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) ## Deprecated diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md index b9e3530571..8a3b6d3d30 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverBaseResult title: InfiniteQueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 3f28cb3f55..5537ec0820 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingErrorResult title: InfiniteQueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:1094](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1094) +Defined in: [packages/query-core/src/types.ts:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md index 88a592ee92..a5e5e5a5dc 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverLoadingResult title: InfiniteQueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1076](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1076) +Defined in: [packages/query-core/src/types.ts:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md index 5875834ee9..894408e06c 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverOptions title: InfiniteQueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L552) +Defined in: [packages/query-core/src/types.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/query-core/src/types.ts:552](https://github.com/TanStack/q | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | | `initialData?` | \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| () => \| [`InfiniteData`](InfiniteData.md)\<`TQueryFnData`, `TPageParam`\> \| `undefined` | `undefined` | If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet). If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initial data. Initial data is considered stale by default unless a `staleTime` has been set. `initialData` **is persisted** to the cache. | | `initialDataUpdatedAt?` | `number` \| () => `number` \| `undefined` | `undefined` | If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated. | -| `initialPageParam` | `TPageParam` | `undefined` | - | +| `initialPageParam` | `TPageParam` | `undefined` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | | `maxPages?` | `number` | `undefined` | Maximum number of pages to store in the data of an infinite query. | | `meta?` | `Record`\<`string`, `unknown`\> | `undefined` | Additional payload to be stored on each query. Use this property to pass information that can be used in other places. | | `networkMode?` | `"online"` \| `"always"` \| `"offlineFirst"` | `'online'` | Controls whether a query is allowed to run based on the current network connectivity. **See** [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. | diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPendingResult.md index e26743036f..87f01ccae9 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPendingResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPendingResult title: InfiniteQueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) +Defined in: [packages/query-core/src/types.ts:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 72064b180a..3d65b1ae0c 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverPlaceholderResult title: InfiniteQueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:1146](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1146) +Defined in: [packages/query-core/src/types.ts:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 640aad7cdc..965de016a6 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverRefetchErrorResult title: InfiniteQueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:1112](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1112) +Defined in: [packages/query-core/src/types.ts:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md index cef257e77c..5044404fa7 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: InfiniteQueryObserverSuccessResult title: InfiniteQueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1128](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1128) +Defined in: [packages/query-core/src/types.ts:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md index 4c7024880a..26c2d4d6a9 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md +++ b/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryPageParamsOptions title: InfiniteQueryPageParamsOptions --- -Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L364) +Defined in: [packages/query-core/src/types.ts:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) ## Extends @@ -29,4 +29,4 @@ Defined in: [packages/query-core/src/types.ts:364](https://github.com/TanStack/q | ------ | ------ | ------ | | `getNextPageParam` | (`lastPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `lastPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of `hasNextPage`. | | `getPreviousPageParam?` | (`firstPage`: `TQueryFnData`, `allPages`: `TQueryFnData`[], `firstPageParam`: `TPageParam`, `allPageParams`: `TPageParam`[]) => `TPageParam` \| `null` \| `undefined` | This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of `hasPreviousPage`. | -| `initialPageParam` | `TPageParam` | - | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/vue/reference/interfaces/InitialPageParam.md b/docs/framework/vue/reference/interfaces/InitialPageParam.md index ea6c1db362..de2139a43f 100644 --- a/docs/framework/vue/reference/interfaces/InitialPageParam.md +++ b/docs/framework/vue/reference/interfaces/InitialPageParam.md @@ -17,6 +17,6 @@ Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/q ## Properties -| Property | Type | -| ------ | ------ | -| `initialPageParam` | `TPageParam` | +| Property | Type | Description | +| ------ | ------ | ------ | +| `initialPageParam` | `TPageParam` | The page param to start from when an infinite query has no pages yet. It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the value returned by `getNextPageParam` or `getPreviousPageParam`. It only applies while the query has no pages: once a first page exists, refetching starts from that page's own param instead. | diff --git a/docs/framework/vue/reference/interfaces/InvalidateOptions.md b/docs/framework/vue/reference/interfaces/InvalidateOptions.md index 0d316e57de..a207356c18 100644 --- a/docs/framework/vue/reference/interfaces/InvalidateOptions.md +++ b/docs/framework/vue/reference/interfaces/InvalidateOptions.md @@ -3,7 +3,7 @@ id: InvalidateOptions title: InvalidateOptions --- -Defined in: [packages/query-core/src/types.ts:748](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L748) +Defined in: [packages/query-core/src/types.ts:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md index 5a7e4ba9f4..b6dd5a861e 100644 --- a/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md +++ b/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md @@ -3,7 +3,7 @@ id: InvalidateQueryFilters title: InvalidateQueryFilters --- -Defined in: [packages/query-core/src/types.ts:728](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L728) +Defined in: [packages/query-core/src/types.ts:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/vue/reference/interfaces/MutateOptions.md b/docs/framework/vue/reference/interfaces/MutateOptions.md index 89aa57b9e8..fc24904078 100644 --- a/docs/framework/vue/reference/interfaces/MutateOptions.md +++ b/docs/framework/vue/reference/interfaces/MutateOptions.md @@ -3,7 +3,7 @@ id: MutateOptions title: MutateOptions --- -Defined in: [packages/query-core/src/types.ts:1345](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1345) +Defined in: [packages/query-core/src/types.ts:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md index da088c161f..00e1021964 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md @@ -3,7 +3,7 @@ id: MutationObserverBaseResult title: MutationObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:1396](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1396) +Defined in: [packages/query-core/src/types.ts:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/vue/reference/interfaces/MutationObserverErrorResult.md b/docs/framework/vue/reference/interfaces/MutationObserverErrorResult.md index 24ed0a4efb..52c7132d5a 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverErrorResult.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverErrorResult.md @@ -3,7 +3,7 @@ id: MutationObserverErrorResult title: MutationObserverErrorResult --- -Defined in: [packages/query-core/src/types.ts:1503](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1503) +Defined in: [packages/query-core/src/types.ts:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/vue/reference/interfaces/MutationObserverIdleResult.md b/docs/framework/vue/reference/interfaces/MutationObserverIdleResult.md index 6922ecbec4..67f98f0942 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverIdleResult.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverIdleResult.md @@ -3,7 +3,7 @@ id: MutationObserverIdleResult title: MutationObserverIdleResult --- -Defined in: [packages/query-core/src/types.ts:1461](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1461) +Defined in: [packages/query-core/src/types.ts:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/vue/reference/interfaces/MutationObserverLoadingResult.md b/docs/framework/vue/reference/interfaces/MutationObserverLoadingResult.md index 6359bfb434..51c8547e28 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverLoadingResult.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverLoadingResult.md @@ -3,7 +3,7 @@ id: MutationObserverLoadingResult title: MutationObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:1482](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1482) +Defined in: [packages/query-core/src/types.ts:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/vue/reference/interfaces/MutationObserverOptions.md b/docs/framework/vue/reference/interfaces/MutationObserverOptions.md index 30f1025de9..0e1022e421 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverOptions.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverOptions.md @@ -3,7 +3,7 @@ id: MutationObserverOptions title: MutationObserverOptions --- -Defined in: [packages/query-core/src/types.ts:1328](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1328) +Defined in: [packages/query-core/src/types.ts:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) ## Extends diff --git a/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md index aa19fc4377..14a5486690 100644 --- a/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md +++ b/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md @@ -3,7 +3,7 @@ id: MutationObserverSuccessResult title: MutationObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:1524](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1524) +Defined in: [packages/query-core/src/types.ts:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) The raw state stored on a `Mutation` instance. This is the underlying state that observer results (e.g. `MutationObserverResult`) are derived from. diff --git a/docs/framework/vue/reference/interfaces/NotifyEvent.md b/docs/framework/vue/reference/interfaces/NotifyEvent.md index af92bbbf7b..6303b2bb65 100644 --- a/docs/framework/vue/reference/interfaces/NotifyEvent.md +++ b/docs/framework/vue/reference/interfaces/NotifyEvent.md @@ -3,7 +3,7 @@ id: NotifyEvent title: NotifyEvent --- -Defined in: [packages/query-core/src/types.ts:1601](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1601) +Defined in: [packages/query-core/src/types.ts:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) ## Properties diff --git a/docs/framework/vue/reference/interfaces/QueryClientConfig.md b/docs/framework/vue/reference/interfaces/QueryClientConfig.md index f9d91c0d77..b207c49a90 100644 --- a/docs/framework/vue/reference/interfaces/QueryClientConfig.md +++ b/docs/framework/vue/reference/interfaces/QueryClientConfig.md @@ -3,7 +3,7 @@ id: QueryClientConfig title: QueryClientConfig --- -Defined in: [packages/query-core/src/types.ts:1556](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1556) +Defined in: [packages/query-core/src/types.ts:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) ## Properties diff --git a/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md b/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md index d702d5a779..47891676ea 100644 --- a/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md +++ b/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md @@ -3,7 +3,7 @@ id: QueryExecuteOptions title: QueryExecuteOptions --- -Defined in: [packages/query-core/src/types.ts:587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L587) +Defined in: [packages/query-core/src/types.ts:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md index 10f594f63a..95abf673e0 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md @@ -3,7 +3,7 @@ id: QueryObserverBaseResult title: QueryObserverBaseResult --- -Defined in: [packages/query-core/src/types.ts:780](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L780) +Defined in: [packages/query-core/src/types.ts:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) ## Extended by diff --git a/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md index 69f369e1eb..2c0254014d 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingErrorResult title: QueryObserverLoadingErrorResult --- -Defined in: [packages/query-core/src/types.ts:939](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L939) +Defined in: [packages/query-core/src/types.ts:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md index 6cc1730b99..d4fe735d5c 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md @@ -3,7 +3,7 @@ id: QueryObserverLoadingResult title: QueryObserverLoadingResult --- -Defined in: [packages/query-core/src/types.ts:923](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L923) +Defined in: [packages/query-core/src/types.ts:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverOptions.md b/docs/framework/vue/reference/interfaces/QueryObserverOptions.md index 6fa4237935..40c10b2503 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverOptions.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverOptions.md @@ -3,7 +3,7 @@ id: QueryObserverOptions title: QueryObserverOptions --- -Defined in: [packages/query-core/src/types.ts:393](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L393) +Defined in: [packages/query-core/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md index adbf77bf3f..2b6e46e2d9 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md @@ -3,7 +3,7 @@ id: QueryObserverPendingResult title: QueryObserverPendingResult --- -Defined in: [packages/query-core/src/types.ts:908](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L908) +Defined in: [packages/query-core/src/types.ts:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md index 41944943f5..c6c637916d 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md @@ -3,7 +3,7 @@ id: QueryObserverPlaceholderResult title: QueryObserverPlaceholderResult --- -Defined in: [packages/query-core/src/types.ts:987](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L987) +Defined in: [packages/query-core/src/types.ts:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md index a8afb4202f..e24cf9b520 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md @@ -3,7 +3,7 @@ id: QueryObserverRefetchErrorResult title: QueryObserverRefetchErrorResult --- -Defined in: [packages/query-core/src/types.ts:955](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L955) +Defined in: [packages/query-core/src/types.ts:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md index bc5e7cb44f..0e1040c026 100644 --- a/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md +++ b/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md @@ -3,7 +3,7 @@ id: QueryObserverSuccessResult title: QueryObserverSuccessResult --- -Defined in: [packages/query-core/src/types.ts:971](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L971) +Defined in: [packages/query-core/src/types.ts:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) ## Extends diff --git a/docs/framework/vue/reference/interfaces/RefetchOptions.md b/docs/framework/vue/reference/interfaces/RefetchOptions.md index ed00c042bc..22ef813d38 100644 --- a/docs/framework/vue/reference/interfaces/RefetchOptions.md +++ b/docs/framework/vue/reference/interfaces/RefetchOptions.md @@ -3,7 +3,7 @@ id: RefetchOptions title: RefetchOptions --- -Defined in: [packages/query-core/src/types.ts:717](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L717) +Defined in: [packages/query-core/src/types.ts:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) ## Extends diff --git a/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md b/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md index 0781c59994..864f5c14e1 100644 --- a/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md +++ b/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md @@ -3,7 +3,7 @@ id: RefetchQueryFilters title: RefetchQueryFilters --- -Defined in: [packages/query-core/src/types.ts:744](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L744) +Defined in: [packages/query-core/src/types.ts:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) Filters used to select queries, for example in `queryClient.getQueriesData` or `queryClient.invalidateQueries`. All provided filters must match; filters that are left unspecified are ignored. diff --git a/docs/framework/vue/reference/interfaces/ResetOptions.md b/docs/framework/vue/reference/interfaces/ResetOptions.md index 152f9d089e..0679cafaad 100644 --- a/docs/framework/vue/reference/interfaces/ResetOptions.md +++ b/docs/framework/vue/reference/interfaces/ResetOptions.md @@ -3,7 +3,7 @@ id: ResetOptions title: ResetOptions --- -Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) +Defined in: [packages/query-core/src/types.ts:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) ## Extends diff --git a/docs/framework/vue/reference/interfaces/ResultOptions.md b/docs/framework/vue/reference/interfaces/ResultOptions.md index 68e0427aed..5025179c46 100644 --- a/docs/framework/vue/reference/interfaces/ResultOptions.md +++ b/docs/framework/vue/reference/interfaces/ResultOptions.md @@ -3,7 +3,7 @@ id: ResultOptions title: ResultOptions --- -Defined in: [packages/query-core/src/types.ts:707](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L707) +Defined in: [packages/query-core/src/types.ts:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) ## Extended by diff --git a/docs/framework/vue/reference/interfaces/SetDataOptions.md b/docs/framework/vue/reference/interfaces/SetDataOptions.md index f1cfb66693..a4207d6e55 100644 --- a/docs/framework/vue/reference/interfaces/SetDataOptions.md +++ b/docs/framework/vue/reference/interfaces/SetDataOptions.md @@ -3,7 +3,7 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1587](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1587) +Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) ## Properties diff --git a/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index c47d75239a..726fc8c79c 100644 --- a/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md +++ b/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedInfiniteQueryObserverOptions type DefaultedInfiniteQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:570](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L570) +Defined in: [packages/query-core/src/types.ts:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md index 8d9caecbd8..27bcabb8f6 100644 --- a/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md +++ b/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md @@ -7,7 +7,7 @@ title: DefaultedQueryObserverOptions type DefaultedQueryObserverOptions = WithRequired, "throwOnError" | "refetchOnReconnect" | "queryHash">; ``` -Defined in: [packages/query-core/src/types.ts:541](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L541) +Defined in: [packages/query-core/src/types.ts:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 27a7fc29de..26c748c866 100644 --- a/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md +++ b/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedInfiniteQueryObserverResult = | InfiniteQueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1164](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1164) +Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md index ee00364a56..1cb65091df 100644 --- a/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md +++ b/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md @@ -9,7 +9,7 @@ type DefinedQueryObserverResult = | QueryObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1003](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1003) +Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index 19bccc5f9e..df4f05d659 100644 --- a/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md +++ b/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md @@ -7,7 +7,7 @@ title: EnsureInfiniteQueryDataOptions type EnsureInfiniteQueryDataOptions = FetchInfiniteQueryOptions & object; ``` -Defined in: [packages/query-core/src/types.ts:644](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L644) +Defined in: [packages/query-core/src/types.ts:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) ## Type Declaration diff --git a/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md index 5574ac938a..6a198f37f1 100644 --- a/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md +++ b/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: FetchInfiniteQueryOptions type FetchInfiniteQueryOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:688](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L688) +Defined in: [packages/query-core/src/types.ts:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FetchStatus.md b/docs/framework/vue/reference/type-aliases/FetchStatus.md index 7b34ce471a..fc74a092b8 100644 --- a/docs/framework/vue/reference/type-aliases/FetchStatus.md +++ b/docs/framework/vue/reference/type-aliases/FetchStatus.md @@ -7,4 +7,4 @@ title: FetchStatus type FetchStatus = "fetching" | "paused" | "idle"; ``` -Defined in: [packages/query-core/src/types.ts:778](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L778) +Defined in: [packages/query-core/src/types.ts:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) diff --git a/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md index 9a4fedb4dc..fe7e832880 100644 --- a/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md +++ b/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md @@ -7,7 +7,7 @@ title: InfiniteQueryExecuteOptions type InfiniteQueryExecuteOptions = Omit, TQueryKey, TPageParam>, "initialPageParam"> & InitialPageParam & InfiniteQueryPages; ``` -Defined in: [packages/query-core/src/types.ts:667](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L667) +Defined in: [packages/query-core/src/types.ts:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md index 100e883bc6..6c05ab793f 100644 --- a/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md +++ b/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md @@ -12,7 +12,7 @@ type InfiniteQueryObserverResult = | InfiniteQueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutateFunction.md b/docs/framework/vue/reference/type-aliases/MutateFunction.md index db2e70bd2e..dba3e5fb2a 100644 --- a/docs/framework/vue/reference/type-aliases/MutateFunction.md +++ b/docs/framework/vue/reference/type-aliases/MutateFunction.md @@ -7,7 +7,7 @@ title: MutateFunction type MutateFunction = (...rest: MutateFunctionRest) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1387](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1387) +Defined in: [packages/query-core/src/types.ts:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md b/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md index c0d6cad7d5..d14b813e86 100644 --- a/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md +++ b/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md @@ -7,7 +7,7 @@ title: MutateFunctionRest type MutateFunctionRest = undefined extends TVariables ? [TVariables, MutateOptions] : [TVariables, MutateOptions]; ``` -Defined in: [packages/query-core/src/types.ts:1372](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1372) +Defined in: [packages/query-core/src/types.ts:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationFunction.md b/docs/framework/vue/reference/type-aliases/MutationFunction.md index 3a96dfe1b1..5ac7a65ff2 100644 --- a/docs/framework/vue/reference/type-aliases/MutationFunction.md +++ b/docs/framework/vue/reference/type-aliases/MutationFunction.md @@ -7,7 +7,7 @@ title: MutationFunction type MutationFunction = (variables: TVariables, context: MutationFunctionContext) => Promise; ``` -Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md b/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md index b415353dab..07574115fc 100644 --- a/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md +++ b/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md @@ -7,7 +7,7 @@ title: MutationFunctionContext type MutationFunctionContext = object; ``` -Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Properties diff --git a/docs/framework/vue/reference/type-aliases/MutationKey.md b/docs/framework/vue/reference/type-aliases/MutationKey.md index db6a46a7eb..f592a35064 100644 --- a/docs/framework/vue/reference/type-aliases/MutationKey.md +++ b/docs/framework/vue/reference/type-aliases/MutationKey.md @@ -7,4 +7,4 @@ title: MutationKey type MutationKey = Register extends object ? TMutationKey extends ReadonlyArray ? TMutationKey : TMutationKey extends unknown[] ? TMutationKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:1181](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1181) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) diff --git a/docs/framework/vue/reference/type-aliases/MutationMeta.md b/docs/framework/vue/reference/type-aliases/MutationMeta.md index 6af02dbc24..2cbee82e82 100644 --- a/docs/framework/vue/reference/type-aliases/MutationMeta.md +++ b/docs/framework/vue/reference/type-aliases/MutationMeta.md @@ -7,4 +7,4 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1198](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1198) +Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) diff --git a/docs/framework/vue/reference/type-aliases/MutationObserverResult.md b/docs/framework/vue/reference/type-aliases/MutationObserverResult.md index 8849385470..38d909e76f 100644 --- a/docs/framework/vue/reference/type-aliases/MutationObserverResult.md +++ b/docs/framework/vue/reference/type-aliases/MutationObserverResult.md @@ -11,7 +11,7 @@ type MutationObserverResult = | MutationObserverSuccessResult; ``` -Defined in: [packages/query-core/src/types.ts:1545](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1545) +Defined in: [packages/query-core/src/types.ts:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationScope.md b/docs/framework/vue/reference/type-aliases/MutationScope.md index 51c8c11dd0..a4c9da417a 100644 --- a/docs/framework/vue/reference/type-aliases/MutationScope.md +++ b/docs/framework/vue/reference/type-aliases/MutationScope.md @@ -7,7 +7,7 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1194) +Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) ## Properties diff --git a/docs/framework/vue/reference/type-aliases/MutationStatus.md b/docs/framework/vue/reference/type-aliases/MutationStatus.md index 6f9c411bf7..6f48a359df 100644 --- a/docs/framework/vue/reference/type-aliases/MutationStatus.md +++ b/docs/framework/vue/reference/type-aliases/MutationStatus.md @@ -7,4 +7,4 @@ title: MutationStatus type MutationStatus = "idle" | "pending" | "success" | "error"; ``` -Defined in: [packages/query-core/src/types.ts:1192](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1192) +Defined in: [packages/query-core/src/types.ts:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) diff --git a/docs/framework/vue/reference/type-aliases/NotifyEventType.md b/docs/framework/vue/reference/type-aliases/NotifyEventType.md index 94a90ddcde..2a0ed02aae 100644 --- a/docs/framework/vue/reference/type-aliases/NotifyEventType.md +++ b/docs/framework/vue/reference/type-aliases/NotifyEventType.md @@ -14,4 +14,4 @@ type NotifyEventType = | "observerOptionsUpdated"; ``` -Defined in: [packages/query-core/src/types.ts:1592](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1592) +Defined in: [packages/query-core/src/types.ts:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) diff --git a/docs/framework/vue/reference/type-aliases/QueryObserverResult.md b/docs/framework/vue/reference/type-aliases/QueryObserverResult.md index 815be550f4..0ee2201378 100644 --- a/docs/framework/vue/reference/type-aliases/QueryObserverResult.md +++ b/docs/framework/vue/reference/type-aliases/QueryObserverResult.md @@ -12,7 +12,7 @@ type QueryObserverResult = | QueryObserverPlaceholderResult; ``` -Defined in: [packages/query-core/src/types.ts:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryStatus.md b/docs/framework/vue/reference/type-aliases/QueryStatus.md index 4cf61f4dc6..4717b046ad 100644 --- a/docs/framework/vue/reference/type-aliases/QueryStatus.md +++ b/docs/framework/vue/reference/type-aliases/QueryStatus.md @@ -7,4 +7,4 @@ title: QueryStatus type QueryStatus = "pending" | "error" | "success"; ``` -Defined in: [packages/query-core/src/types.ts:776](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L776) +Defined in: [packages/query-core/src/types.ts:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) diff --git a/docs/framework/vue/reference/type-aliases/ThrowOnError.md b/docs/framework/vue/reference/type-aliases/ThrowOnError.md index d715b760fc..d9498dcd94 100644 --- a/docs/framework/vue/reference/type-aliases/ThrowOnError.md +++ b/docs/framework/vue/reference/type-aliases/ThrowOnError.md @@ -9,7 +9,7 @@ type ThrowOnError = | (error: TError, query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:381](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L381) +Defined in: [packages/query-core/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/WithRequired.md b/docs/framework/vue/reference/type-aliases/WithRequired.md index b9eceb131e..e81802aa38 100644 --- a/docs/framework/vue/reference/type-aliases/WithRequired.md +++ b/docs/framework/vue/reference/type-aliases/WithRequired.md @@ -7,7 +7,7 @@ title: WithRequired type WithRequired = TTarget & { [_ in TKey]: {} }; ``` -Defined in: [packages/query-core/src/types.ts:537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L537) +Defined in: [packages/query-core/src/types.ts:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) ## Type Parameters diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts index a4d926f701..7d91dc1e6b 100644 --- a/packages/query-core/src/types.ts +++ b/packages/query-core/src/types.ts @@ -358,6 +358,13 @@ export interface QueryOptions< } export interface InitialPageParam { + /** + * The page param to start from when an infinite query has no pages yet. + * It is passed to `queryFn` as `pageParam` for the first page; every page after that gets the + * value returned by `getNextPageParam` or `getPreviousPageParam`. + * It only applies while the query has no pages: once a first page exists, refetching starts from + * that page's own param instead. + */ initialPageParam: TPageParam }