From a68c11f5fc39098a25d49527b0373d124959f87b Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Sat, 19 Sep 2026 17:50:27 +0900 Subject: [PATCH] docs(query-core): add JSDoc for shared option and registry types --- .../reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../reference/interfaces/MutationOptions.md | 2 +- .../reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/QueryOptions.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../angular/reference/interfaces/Register.md | 22 ++++++- .../reference/interfaces/ResetOptions.md | 2 +- .../reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../reference/type-aliases/AnyDataTag.md | 2 +- .../angular/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../reference/type-aliases/QueryStatus.md | 2 +- .../reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../reference/variables/dataTagSymbol.md | 2 +- .../reference/variables/unsetMarker.md | 2 +- .../lit/reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../lit/reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../lit/reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../reference/interfaces/MutationOptions.md | 2 +- .../lit/reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../lit/reference/interfaces/QueryOptions.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../lit/reference/interfaces/Register.md | 22 ++++++- .../lit/reference/interfaces/ResetOptions.md | 2 +- .../lit/reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../lit/reference/type-aliases/AnyDataTag.md | 2 +- .../lit/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../lit/reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../lit/reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../lit/reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../lit/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../lit/reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../lit/reference/type-aliases/QueryStatus.md | 2 +- .../lit/reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../lit/reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../lit/reference/variables/dataTagSymbol.md | 2 +- .../lit/reference/variables/unsetMarker.md | 2 +- .../reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../reference/interfaces/MutationOptions.md | 2 +- .../reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/QueryOptions.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../preact/reference/interfaces/Register.md | 22 ++++++- .../reference/interfaces/ResetOptions.md | 2 +- .../reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../reference/type-aliases/AnyDataTag.md | 2 +- .../preact/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../preact/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../reference/type-aliases/QueryStatus.md | 2 +- .../reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../reference/variables/dataTagSymbol.md | 2 +- .../preact/reference/variables/unsetMarker.md | 2 +- .../reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../reference/interfaces/MutationOptions.md | 2 +- .../react/reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/QueryOptions.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../react/reference/interfaces/Register.md | 22 ++++++- .../reference/interfaces/ResetOptions.md | 2 +- .../reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../reference/type-aliases/AnyDataTag.md | 2 +- .../react/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../react/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../react/reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../reference/type-aliases/QueryStatus.md | 2 +- .../react/reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../reference/variables/dataTagSymbol.md | 2 +- .../react/reference/variables/unsetMarker.md | 2 +- .../reference/interfaces/CancelOptions.md | 5 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../solid/reference/interfaces/NotifyEvent.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../solid/reference/interfaces/Register.md | 22 ++++++- .../reference/interfaces/ResetOptions.md | 2 +- .../reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../reference/type-aliases/AnyDataTag.md | 2 +- .../solid/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../solid/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../solid/reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../reference/type-aliases/QueryStatus.md | 2 +- .../solid/reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../reference/variables/dataTagSymbol.md | 2 +- .../solid/reference/variables/unsetMarker.md | 2 +- .../reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../reference/interfaces/MutationOptions.md | 2 +- .../reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/QueryOptions.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../svelte/reference/interfaces/Register.md | 22 ++++++- .../reference/interfaces/ResetOptions.md | 2 +- .../reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../reference/type-aliases/AnyDataTag.md | 2 +- .../svelte/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../svelte/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../reference/type-aliases/QueryStatus.md | 2 +- .../reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../reference/variables/dataTagSymbol.md | 2 +- .../svelte/reference/variables/unsetMarker.md | 2 +- .../vue/reference/interfaces/CancelOptions.md | 5 +- .../reference/interfaces/DefaultOptions.md | 2 +- .../interfaces/EnsureQueryDataOptions.md | 2 +- .../interfaces/FetchNextPageOptions.md | 2 +- .../interfaces/FetchPreviousPageOptions.md | 2 +- .../reference/interfaces/FetchQueryOptions.md | 2 +- .../vue/reference/interfaces/InfiniteData.md | 5 +- .../InfiniteQueryObserverBaseResult.md | 2 +- ...InfiniteQueryObserverLoadingErrorResult.md | 2 +- .../InfiniteQueryObserverLoadingResult.md | 2 +- .../InfiniteQueryObserverOptions.md | 2 +- .../InfiniteQueryObserverPendingResult.md | 2 +- .../InfiniteQueryObserverPlaceholderResult.md | 2 +- ...InfiniteQueryObserverRefetchErrorResult.md | 2 +- .../InfiniteQueryObserverSuccessResult.md | 2 +- .../InfiniteQueryPageParamsOptions.md | 2 +- .../reference/interfaces/InitialPageParam.md | 2 +- .../reference/interfaces/InvalidateOptions.md | 2 +- .../interfaces/InvalidateQueryFilters.md | 2 +- .../vue/reference/interfaces/MutateOptions.md | 2 +- .../interfaces/MutationObserverBaseResult.md | 2 +- .../interfaces/MutationObserverErrorResult.md | 2 +- .../interfaces/MutationObserverIdleResult.md | 2 +- .../MutationObserverLoadingResult.md | 2 +- .../interfaces/MutationObserverOptions.md | 2 +- .../MutationObserverSuccessResult.md | 2 +- .../vue/reference/interfaces/NotifyEvent.md | 2 +- .../reference/interfaces/QueryClientConfig.md | 2 +- .../interfaces/QueryExecuteOptions.md | 2 +- .../interfaces/QueryObserverBaseResult.md | 2 +- .../QueryObserverLoadingErrorResult.md | 2 +- .../interfaces/QueryObserverLoadingResult.md | 2 +- .../interfaces/QueryObserverOptions.md | 2 +- .../interfaces/QueryObserverPendingResult.md | 2 +- .../QueryObserverPlaceholderResult.md | 2 +- .../QueryObserverRefetchErrorResult.md | 2 +- .../interfaces/QueryObserverSuccessResult.md | 2 +- .../reference/interfaces/RefetchOptions.md | 2 +- .../interfaces/RefetchQueryFilters.md | 2 +- .../vue/reference/interfaces/Register.md | 22 ++++++- .../vue/reference/interfaces/ResetOptions.md | 2 +- .../vue/reference/interfaces/ResultOptions.md | 2 +- .../reference/interfaces/SetDataOptions.md | 6 +- .../vue/reference/type-aliases/AnyDataTag.md | 2 +- .../vue/reference/type-aliases/DataTag.md | 2 +- .../reference/type-aliases/DefaultError.md | 5 +- .../DefaultedInfiniteQueryObserverOptions.md | 2 +- .../DefaultedQueryObserverOptions.md | 2 +- .../DefinedInfiniteQueryObserverResult.md | 2 +- .../DefinedQueryObserverResult.md | 2 +- .../EnsureInfiniteQueryDataOptions.md | 2 +- .../type-aliases/FetchInfiniteQueryOptions.md | 2 +- .../vue/reference/type-aliases/FetchStatus.md | 2 +- .../type-aliases/GetNextPageParamFunction.md | 2 +- .../GetPreviousPageParamFunction.md | 2 +- .../type-aliases/InferDataFromTag.md | 2 +- .../type-aliases/InferErrorFromTag.md | 2 +- .../InfiniteQueryExecuteOptions.md | 2 +- .../InfiniteQueryObserverResult.md | 2 +- .../type-aliases/InitialDataFunction.md | 2 +- .../reference/type-aliases/MutateFunction.md | 2 +- .../type-aliases/MutateFunctionRest.md | 2 +- .../type-aliases/MutationFunction.md | 2 +- .../type-aliases/MutationFunctionContext.md | 2 +- .../vue/reference/type-aliases/MutationKey.md | 5 +- .../reference/type-aliases/MutationMeta.md | 5 +- .../type-aliases/MutationObserverResult.md | 2 +- .../reference/type-aliases/MutationScope.md | 6 +- .../reference/type-aliases/MutationStatus.md | 2 +- .../vue/reference/type-aliases/NetworkMode.md | 2 +- .../reference/type-aliases/NotifyEventType.md | 2 +- .../type-aliases/NotifyOnChangeProps.md | 2 +- .../type-aliases/PlaceholderDataFunction.md | 2 +- .../QueriesPlaceholderDataFunction.md | 2 +- .../type-aliases/QueryBooleanOption.md | 2 +- .../reference/type-aliases/QueryFunction.md | 2 +- .../type-aliases/QueryFunctionContext.md | 2 +- .../vue/reference/type-aliases/QueryKey.md | 5 +- .../type-aliases/QueryKeyHashFunction.md | 2 +- .../type-aliases/QueryKeyWithDataTag.md | 2 +- .../vue/reference/type-aliases/QueryMeta.md | 5 +- .../type-aliases/QueryObserverResult.md | 2 +- .../reference/type-aliases/QueryPersister.md | 2 +- .../vue/reference/type-aliases/QueryStatus.md | 2 +- .../vue/reference/type-aliases/StaleTime.md | 2 +- .../type-aliases/StaleTimeFunction.md | 2 +- .../reference/type-aliases/ThrowOnError.md | 2 +- .../vue/reference/type-aliases/UnsetMarker.md | 2 +- .../reference/type-aliases/WithRequired.md | 2 +- .../type-aliases/dataTagErrorSymbol.md | 2 +- .../reference/type-aliases/dataTagSymbol.md | 2 +- .../reference/variables/dataTagErrorSymbol.md | 2 +- .../vue/reference/variables/dataTagSymbol.md | 2 +- .../vue/reference/variables/unsetMarker.md | 2 +- packages/query-core/src/types.ts | 57 +++++++++++++++++++ 665 files changed, 1064 insertions(+), 664 deletions(-) diff --git a/docs/framework/angular/reference/interfaces/CancelOptions.md b/docs/framework/angular/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/angular/reference/interfaces/CancelOptions.md +++ b/docs/framework/angular/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/angular/reference/interfaces/DefaultOptions.md b/docs/framework/angular/reference/interfaces/DefaultOptions.md index 4124204e04..c83954b7a9 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/angular/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md b/docs/framework/angular/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/angular/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/angular/reference/interfaces/FetchQueryOptions.md b/docs/framework/angular/reference/interfaces/FetchQueryOptions.md index ca3c25500f..c2359c0b63 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/angular/reference/interfaces/InfiniteData.md b/docs/framework/angular/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/angular/reference/interfaces/InfiniteData.md +++ b/docs/framework/angular/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/angular/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InitialPageParam.md b/docs/framework/angular/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/angular/reference/interfaces/InitialPageParam.md +++ b/docs/framework/angular/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/InvalidateOptions.md b/docs/framework/angular/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/angular/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/angular/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 7c84660e7b..2c3cf90b0d 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 40e2a1ffe3..f2c59e68db 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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) +Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/NotifyEvent.md b/docs/framework/angular/reference/interfaces/NotifyEvent.md index 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/angular/reference/interfaces/QueryClientConfig.md b/docs/framework/angular/reference/interfaces/QueryClientConfig.md index 65cc5c4bce..5c7f2981c2 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md b/docs/framework/angular/reference/interfaces/QueryExecuteOptions.md index 11a3860d80..3d8caa5328 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/angular/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/angular/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/angular/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverOptions.md b/docs/framework/angular/reference/interfaces/QueryObserverOptions.md index 291eea1dbb..627cde2654 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/angular/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/angular/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/angular/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/angular/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/angular/reference/interfaces/QueryOptions.md b/docs/framework/angular/reference/interfaces/QueryOptions.md index fb3e168c5d..2dbbbc1bda 100644 --- a/docs/framework/angular/reference/interfaces/QueryOptions.md +++ b/docs/framework/angular/reference/interfaces/QueryOptions.md @@ -3,7 +3,7 @@ id: QueryOptions title: QueryOptions --- -Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243) +Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278) ## Type Parameters diff --git a/docs/framework/angular/reference/interfaces/RefetchOptions.md b/docs/framework/angular/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md b/docs/framework/angular/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/angular/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/angular/reference/interfaces/Register.md +++ b/docs/framework/angular/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/angular/reference/interfaces/ResetOptions.md b/docs/framework/angular/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/angular/reference/interfaces/ResultOptions.md b/docs/framework/angular/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/angular/reference/interfaces/SetDataOptions.md b/docs/framework/angular/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/angular/reference/interfaces/SetDataOptions.md +++ b/docs/framework/angular/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/angular/reference/type-aliases/AnyDataTag.md b/docs/framework/angular/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/angular/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/angular/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/angular/reference/type-aliases/DataTag.md b/docs/framework/angular/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/angular/reference/type-aliases/DataTag.md +++ b/docs/framework/angular/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefaultError.md b/docs/framework/angular/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/angular/reference/type-aliases/DefaultError.md +++ b/docs/framework/angular/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/angular/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/angular/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/angular/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/angular/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/FetchStatus.md b/docs/framework/angular/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/angular/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/angular/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/angular/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/angular/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/angular/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/angular/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/angular/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InferDataFromTag.md b/docs/framework/angular/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/angular/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/angular/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InferErrorFromTag.md b/docs/framework/angular/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/angular/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/angular/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/angular/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/angular/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/InitialDataFunction.md b/docs/framework/angular/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/angular/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/angular/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutateFunction.md b/docs/framework/angular/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md b/docs/framework/angular/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationFunction.md b/docs/framework/angular/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md b/docs/framework/angular/reference/type-aliases/MutationFunctionContext.md index 74c4e935c7..103c255061 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/angular/reference/type-aliases/MutationKey.md b/docs/framework/angular/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/angular/reference/type-aliases/MutationKey.md +++ b/docs/framework/angular/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/angular/reference/type-aliases/MutationMeta.md b/docs/framework/angular/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/angular/reference/type-aliases/MutationMeta.md +++ b/docs/framework/angular/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/angular/reference/type-aliases/MutationObserverResult.md b/docs/framework/angular/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/MutationScope.md b/docs/framework/angular/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/angular/reference/type-aliases/MutationScope.md +++ b/docs/framework/angular/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/angular/reference/type-aliases/MutationStatus.md b/docs/framework/angular/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/angular/reference/type-aliases/NetworkMode.md b/docs/framework/angular/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/angular/reference/type-aliases/NetworkMode.md +++ b/docs/framework/angular/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/angular/reference/type-aliases/NotifyEventType.md b/docs/framework/angular/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/angular/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/angular/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/angular/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/angular/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/angular/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/angular/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/angular/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/angular/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/angular/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/angular/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/angular/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryBooleanOption.md b/docs/framework/angular/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/angular/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/angular/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryFunction.md b/docs/framework/angular/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/angular/reference/type-aliases/QueryFunction.md +++ b/docs/framework/angular/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryFunctionContext.md b/docs/framework/angular/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/angular/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/angular/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryKey.md b/docs/framework/angular/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/angular/reference/type-aliases/QueryKey.md +++ b/docs/framework/angular/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/angular/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/angular/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/angular/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/angular/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/angular/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/angular/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/angular/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryMeta.md b/docs/framework/angular/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/angular/reference/type-aliases/QueryMeta.md +++ b/docs/framework/angular/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/angular/reference/type-aliases/QueryObserverResult.md b/docs/framework/angular/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryPersister.md b/docs/framework/angular/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/angular/reference/type-aliases/QueryPersister.md +++ b/docs/framework/angular/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/QueryStatus.md b/docs/framework/angular/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/angular/reference/type-aliases/StaleTime.md b/docs/framework/angular/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/angular/reference/type-aliases/StaleTime.md +++ b/docs/framework/angular/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/angular/reference/type-aliases/StaleTimeFunction.md b/docs/framework/angular/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/angular/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/angular/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/ThrowOnError.md b/docs/framework/angular/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/UnsetMarker.md b/docs/framework/angular/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/angular/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/angular/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/angular/reference/type-aliases/WithRequired.md b/docs/framework/angular/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/angular/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/angular/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/angular/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/angular/reference/type-aliases/dataTagSymbol.md b/docs/framework/angular/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/angular/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/angular/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/angular/reference/variables/dataTagErrorSymbol.md b/docs/framework/angular/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/angular/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/angular/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/angular/reference/variables/dataTagSymbol.md b/docs/framework/angular/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/angular/reference/variables/dataTagSymbol.md +++ b/docs/framework/angular/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/angular/reference/variables/unsetMarker.md b/docs/framework/angular/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/angular/reference/variables/unsetMarker.md +++ b/docs/framework/angular/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/lit/reference/interfaces/CancelOptions.md b/docs/framework/lit/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/lit/reference/interfaces/CancelOptions.md +++ b/docs/framework/lit/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/lit/reference/interfaces/DefaultOptions.md b/docs/framework/lit/reference/interfaces/DefaultOptions.md index 4124204e04..c83954b7a9 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/lit/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md b/docs/framework/lit/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/lit/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/lit/reference/interfaces/FetchQueryOptions.md b/docs/framework/lit/reference/interfaces/FetchQueryOptions.md index ca3c25500f..c2359c0b63 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/lit/reference/interfaces/InfiniteData.md b/docs/framework/lit/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/lit/reference/interfaces/InfiniteData.md +++ b/docs/framework/lit/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/lit/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InitialPageParam.md b/docs/framework/lit/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/lit/reference/interfaces/InitialPageParam.md +++ b/docs/framework/lit/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/InvalidateOptions.md b/docs/framework/lit/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/lit/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/lit/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 7c84660e7b..2c3cf90b0d 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 40e2a1ffe3..f2c59e68db 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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) +Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/NotifyEvent.md b/docs/framework/lit/reference/interfaces/NotifyEvent.md index 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/lit/reference/interfaces/QueryClientConfig.md b/docs/framework/lit/reference/interfaces/QueryClientConfig.md index 65cc5c4bce..5c7f2981c2 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md b/docs/framework/lit/reference/interfaces/QueryExecuteOptions.md index 11a3860d80..3d8caa5328 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/lit/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/lit/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/lit/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverOptions.md b/docs/framework/lit/reference/interfaces/QueryObserverOptions.md index d57f0e4b80..8722cbd51a 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/lit/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/lit/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/lit/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/lit/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/lit/reference/interfaces/QueryOptions.md b/docs/framework/lit/reference/interfaces/QueryOptions.md index fb3e168c5d..2dbbbc1bda 100644 --- a/docs/framework/lit/reference/interfaces/QueryOptions.md +++ b/docs/framework/lit/reference/interfaces/QueryOptions.md @@ -3,7 +3,7 @@ id: QueryOptions title: QueryOptions --- -Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243) +Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278) ## Type Parameters diff --git a/docs/framework/lit/reference/interfaces/RefetchOptions.md b/docs/framework/lit/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md b/docs/framework/lit/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/lit/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/lit/reference/interfaces/Register.md +++ b/docs/framework/lit/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/lit/reference/interfaces/ResetOptions.md b/docs/framework/lit/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/lit/reference/interfaces/ResultOptions.md b/docs/framework/lit/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/lit/reference/interfaces/SetDataOptions.md b/docs/framework/lit/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/lit/reference/interfaces/SetDataOptions.md +++ b/docs/framework/lit/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/lit/reference/type-aliases/AnyDataTag.md b/docs/framework/lit/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/lit/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/lit/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/lit/reference/type-aliases/DataTag.md b/docs/framework/lit/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/lit/reference/type-aliases/DataTag.md +++ b/docs/framework/lit/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefaultError.md b/docs/framework/lit/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/lit/reference/type-aliases/DefaultError.md +++ b/docs/framework/lit/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/lit/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/lit/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 82087de0eb..c08cb3b271 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/DefinedQueryObserverResult.md index 7ac10bb8df..bf8c6f1dcd 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/lit/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/lit/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FetchStatus.md b/docs/framework/lit/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/lit/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/lit/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/lit/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/lit/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/lit/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/lit/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/lit/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InferDataFromTag.md b/docs/framework/lit/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/lit/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/lit/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InferErrorFromTag.md b/docs/framework/lit/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/lit/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/lit/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/lit/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/lit/reference/type-aliases/InfiniteQueryObserverResult.md index cd7e918e31..2be1919b71 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/InitialDataFunction.md b/docs/framework/lit/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/lit/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/lit/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutateFunction.md b/docs/framework/lit/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md b/docs/framework/lit/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationFunction.md b/docs/framework/lit/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md b/docs/framework/lit/reference/type-aliases/MutationFunctionContext.md index 74c4e935c7..103c255061 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/lit/reference/type-aliases/MutationKey.md b/docs/framework/lit/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/lit/reference/type-aliases/MutationKey.md +++ b/docs/framework/lit/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/lit/reference/type-aliases/MutationMeta.md b/docs/framework/lit/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/lit/reference/type-aliases/MutationMeta.md +++ b/docs/framework/lit/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/lit/reference/type-aliases/MutationObserverResult.md b/docs/framework/lit/reference/type-aliases/MutationObserverResult.md index acf0c2062c..b5d27dd28c 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/MutationScope.md b/docs/framework/lit/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/lit/reference/type-aliases/MutationScope.md +++ b/docs/framework/lit/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/lit/reference/type-aliases/MutationStatus.md b/docs/framework/lit/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/lit/reference/type-aliases/NetworkMode.md b/docs/framework/lit/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/lit/reference/type-aliases/NetworkMode.md +++ b/docs/framework/lit/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/lit/reference/type-aliases/NotifyEventType.md b/docs/framework/lit/reference/type-aliases/NotifyEventType.md index 2c6bac81ba..bf74d83eaa 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/lit/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/lit/reference/type-aliases/NotifyOnChangeProps.md index 522c45796a..c86bee22b0 100644 --- a/docs/framework/lit/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/lit/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/lit/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/lit/reference/type-aliases/PlaceholderDataFunction.md index fe7ad1da13..ec4cdb9f91 100644 --- a/docs/framework/lit/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/lit/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/lit/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/lit/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/lit/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryBooleanOption.md b/docs/framework/lit/reference/type-aliases/QueryBooleanOption.md index fdae2e8c49..90b30a4783 100644 --- a/docs/framework/lit/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/lit/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryFunction.md b/docs/framework/lit/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/lit/reference/type-aliases/QueryFunction.md +++ b/docs/framework/lit/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryFunctionContext.md b/docs/framework/lit/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/lit/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/lit/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryKey.md b/docs/framework/lit/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/lit/reference/type-aliases/QueryKey.md +++ b/docs/framework/lit/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/lit/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/lit/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/lit/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/lit/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/lit/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/lit/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/lit/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryMeta.md b/docs/framework/lit/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/lit/reference/type-aliases/QueryMeta.md +++ b/docs/framework/lit/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/lit/reference/type-aliases/QueryObserverResult.md b/docs/framework/lit/reference/type-aliases/QueryObserverResult.md index ca4f316226..cabf3ffe2c 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryPersister.md b/docs/framework/lit/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/lit/reference/type-aliases/QueryPersister.md +++ b/docs/framework/lit/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/QueryStatus.md b/docs/framework/lit/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/lit/reference/type-aliases/StaleTime.md b/docs/framework/lit/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/lit/reference/type-aliases/StaleTime.md +++ b/docs/framework/lit/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/lit/reference/type-aliases/StaleTimeFunction.md b/docs/framework/lit/reference/type-aliases/StaleTimeFunction.md index 3367771b11..6374adcb1e 100644 --- a/docs/framework/lit/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/lit/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/ThrowOnError.md b/docs/framework/lit/reference/type-aliases/ThrowOnError.md index a3d58bb792..41f02cf3b5 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/UnsetMarker.md b/docs/framework/lit/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/lit/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/lit/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/lit/reference/type-aliases/WithRequired.md b/docs/framework/lit/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/lit/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/lit/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/lit/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/lit/reference/type-aliases/dataTagSymbol.md b/docs/framework/lit/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/lit/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/lit/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/lit/reference/variables/dataTagErrorSymbol.md b/docs/framework/lit/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/lit/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/lit/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/lit/reference/variables/dataTagSymbol.md b/docs/framework/lit/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/lit/reference/variables/dataTagSymbol.md +++ b/docs/framework/lit/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/lit/reference/variables/unsetMarker.md b/docs/framework/lit/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/lit/reference/variables/unsetMarker.md +++ b/docs/framework/lit/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/preact/reference/interfaces/CancelOptions.md b/docs/framework/preact/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/preact/reference/interfaces/CancelOptions.md +++ b/docs/framework/preact/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/preact/reference/interfaces/DefaultOptions.md b/docs/framework/preact/reference/interfaces/DefaultOptions.md index 4124204e04..c83954b7a9 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/preact/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md b/docs/framework/preact/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/preact/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/preact/reference/interfaces/FetchQueryOptions.md b/docs/framework/preact/reference/interfaces/FetchQueryOptions.md index ca3c25500f..c2359c0b63 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/preact/reference/interfaces/InfiniteData.md b/docs/framework/preact/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/preact/reference/interfaces/InfiniteData.md +++ b/docs/framework/preact/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/preact/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InitialPageParam.md b/docs/framework/preact/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/preact/reference/interfaces/InitialPageParam.md +++ b/docs/framework/preact/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/InvalidateOptions.md b/docs/framework/preact/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/preact/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/preact/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 7c84660e7b..2c3cf90b0d 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 40e2a1ffe3..f2c59e68db 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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) +Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/NotifyEvent.md b/docs/framework/preact/reference/interfaces/NotifyEvent.md index 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/preact/reference/interfaces/QueryClientConfig.md b/docs/framework/preact/reference/interfaces/QueryClientConfig.md index 65cc5c4bce..5c7f2981c2 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md b/docs/framework/preact/reference/interfaces/QueryExecuteOptions.md index 11a3860d80..3d8caa5328 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/preact/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/preact/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/preact/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverOptions.md b/docs/framework/preact/reference/interfaces/QueryObserverOptions.md index f2b31e1bf1..28b1a37891 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/preact/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/preact/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/preact/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/preact/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/preact/reference/interfaces/QueryOptions.md b/docs/framework/preact/reference/interfaces/QueryOptions.md index fb3e168c5d..2dbbbc1bda 100644 --- a/docs/framework/preact/reference/interfaces/QueryOptions.md +++ b/docs/framework/preact/reference/interfaces/QueryOptions.md @@ -3,7 +3,7 @@ id: QueryOptions title: QueryOptions --- -Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243) +Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/RefetchOptions.md b/docs/framework/preact/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md b/docs/framework/preact/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/preact/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/preact/reference/interfaces/Register.md +++ b/docs/framework/preact/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/preact/reference/interfaces/ResetOptions.md b/docs/framework/preact/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/preact/reference/interfaces/ResultOptions.md b/docs/framework/preact/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/preact/reference/interfaces/SetDataOptions.md b/docs/framework/preact/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/preact/reference/interfaces/SetDataOptions.md +++ b/docs/framework/preact/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/preact/reference/type-aliases/AnyDataTag.md b/docs/framework/preact/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/preact/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/preact/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/preact/reference/type-aliases/DataTag.md b/docs/framework/preact/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/preact/reference/type-aliases/DataTag.md +++ b/docs/framework/preact/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefaultError.md b/docs/framework/preact/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/preact/reference/type-aliases/DefaultError.md +++ b/docs/framework/preact/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/preact/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/preact/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/preact/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/preact/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FetchStatus.md b/docs/framework/preact/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/preact/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/preact/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/preact/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/preact/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/preact/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/preact/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/preact/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InferDataFromTag.md b/docs/framework/preact/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/preact/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/preact/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InferErrorFromTag.md b/docs/framework/preact/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/preact/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/preact/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/preact/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/preact/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/InitialDataFunction.md b/docs/framework/preact/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/preact/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/preact/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutateFunction.md b/docs/framework/preact/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md b/docs/framework/preact/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationFunction.md b/docs/framework/preact/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md b/docs/framework/preact/reference/type-aliases/MutationFunctionContext.md index 74c4e935c7..103c255061 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/preact/reference/type-aliases/MutationKey.md b/docs/framework/preact/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/preact/reference/type-aliases/MutationKey.md +++ b/docs/framework/preact/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/preact/reference/type-aliases/MutationMeta.md b/docs/framework/preact/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/preact/reference/type-aliases/MutationMeta.md +++ b/docs/framework/preact/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/preact/reference/type-aliases/MutationObserverResult.md b/docs/framework/preact/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/MutationScope.md b/docs/framework/preact/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/preact/reference/type-aliases/MutationScope.md +++ b/docs/framework/preact/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/preact/reference/type-aliases/MutationStatus.md b/docs/framework/preact/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/preact/reference/type-aliases/NetworkMode.md b/docs/framework/preact/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/preact/reference/type-aliases/NetworkMode.md +++ b/docs/framework/preact/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/preact/reference/type-aliases/NotifyEventType.md b/docs/framework/preact/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/preact/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/preact/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/preact/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/preact/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/preact/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/preact/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/preact/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/preact/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/preact/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/preact/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/preact/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryBooleanOption.md b/docs/framework/preact/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/preact/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/preact/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryFunction.md b/docs/framework/preact/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/preact/reference/type-aliases/QueryFunction.md +++ b/docs/framework/preact/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryFunctionContext.md b/docs/framework/preact/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/preact/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/preact/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryKey.md b/docs/framework/preact/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/preact/reference/type-aliases/QueryKey.md +++ b/docs/framework/preact/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/preact/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/preact/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/preact/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/preact/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/preact/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/preact/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/preact/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryMeta.md b/docs/framework/preact/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/preact/reference/type-aliases/QueryMeta.md +++ b/docs/framework/preact/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/preact/reference/type-aliases/QueryObserverResult.md b/docs/framework/preact/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryPersister.md b/docs/framework/preact/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/preact/reference/type-aliases/QueryPersister.md +++ b/docs/framework/preact/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/QueryStatus.md b/docs/framework/preact/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/preact/reference/type-aliases/StaleTime.md b/docs/framework/preact/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/preact/reference/type-aliases/StaleTime.md +++ b/docs/framework/preact/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/preact/reference/type-aliases/StaleTimeFunction.md b/docs/framework/preact/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/preact/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/preact/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/ThrowOnError.md b/docs/framework/preact/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/UnsetMarker.md b/docs/framework/preact/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/preact/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/preact/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/preact/reference/type-aliases/WithRequired.md b/docs/framework/preact/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/preact/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/preact/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/preact/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/preact/reference/type-aliases/dataTagSymbol.md b/docs/framework/preact/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/preact/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/preact/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/preact/reference/variables/dataTagErrorSymbol.md b/docs/framework/preact/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/preact/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/preact/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/preact/reference/variables/dataTagSymbol.md b/docs/framework/preact/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/preact/reference/variables/dataTagSymbol.md +++ b/docs/framework/preact/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/preact/reference/variables/unsetMarker.md b/docs/framework/preact/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/preact/reference/variables/unsetMarker.md +++ b/docs/framework/preact/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/react/reference/interfaces/CancelOptions.md b/docs/framework/react/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/react/reference/interfaces/CancelOptions.md +++ b/docs/framework/react/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/react/reference/interfaces/DefaultOptions.md b/docs/framework/react/reference/interfaces/DefaultOptions.md index 4124204e04..c83954b7a9 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/react/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/react/reference/interfaces/FetchNextPageOptions.md b/docs/framework/react/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/react/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/react/reference/interfaces/FetchQueryOptions.md b/docs/framework/react/reference/interfaces/FetchQueryOptions.md index ca3c25500f..c2359c0b63 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/react/reference/interfaces/InfiniteData.md b/docs/framework/react/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/react/reference/interfaces/InfiniteData.md +++ b/docs/framework/react/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/react/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/react/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/react/reference/interfaces/InitialPageParam.md b/docs/framework/react/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/react/reference/interfaces/InitialPageParam.md +++ b/docs/framework/react/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/react/reference/interfaces/InvalidateOptions.md b/docs/framework/react/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/react/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/react/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 7c84660e7b..2c3cf90b0d 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/react/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 40e2a1ffe3..f2c59e68db 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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) +Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273) ## Extended by diff --git a/docs/framework/react/reference/interfaces/NotifyEvent.md b/docs/framework/react/reference/interfaces/NotifyEvent.md index 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/react/reference/interfaces/QueryClientConfig.md b/docs/framework/react/reference/interfaces/QueryClientConfig.md index 65cc5c4bce..5c7f2981c2 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/react/reference/interfaces/QueryExecuteOptions.md b/docs/framework/react/reference/interfaces/QueryExecuteOptions.md index 11a3860d80..3d8caa5328 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/react/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/react/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/react/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverOptions.md b/docs/framework/react/reference/interfaces/QueryObserverOptions.md index f2b31e1bf1..28b1a37891 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/react/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/react/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/react/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/react/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/react/reference/interfaces/QueryOptions.md b/docs/framework/react/reference/interfaces/QueryOptions.md index fb3e168c5d..2dbbbc1bda 100644 --- a/docs/framework/react/reference/interfaces/QueryOptions.md +++ b/docs/framework/react/reference/interfaces/QueryOptions.md @@ -3,7 +3,7 @@ id: QueryOptions title: QueryOptions --- -Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243) +Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/RefetchOptions.md b/docs/framework/react/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/react/reference/interfaces/RefetchQueryFilters.md b/docs/framework/react/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/react/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/react/reference/interfaces/Register.md +++ b/docs/framework/react/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/react/reference/interfaces/ResetOptions.md b/docs/framework/react/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/react/reference/interfaces/ResultOptions.md b/docs/framework/react/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/react/reference/interfaces/SetDataOptions.md b/docs/framework/react/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/react/reference/interfaces/SetDataOptions.md +++ b/docs/framework/react/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/react/reference/type-aliases/AnyDataTag.md b/docs/framework/react/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/react/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/react/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/react/reference/type-aliases/DataTag.md b/docs/framework/react/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/react/reference/type-aliases/DataTag.md +++ b/docs/framework/react/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefaultError.md b/docs/framework/react/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/react/reference/type-aliases/DefaultError.md +++ b/docs/framework/react/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/react/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/react/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/react/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/react/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/react/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/react/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FetchStatus.md b/docs/framework/react/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/react/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/react/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/react/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/react/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/react/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/react/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/react/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InferDataFromTag.md b/docs/framework/react/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/react/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/react/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InferErrorFromTag.md b/docs/framework/react/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/react/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/react/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/react/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/react/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/InitialDataFunction.md b/docs/framework/react/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/react/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/react/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutateFunction.md b/docs/framework/react/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutateFunctionRest.md b/docs/framework/react/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationFunction.md b/docs/framework/react/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationFunctionContext.md b/docs/framework/react/reference/type-aliases/MutationFunctionContext.md index 74c4e935c7..103c255061 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/react/reference/type-aliases/MutationKey.md b/docs/framework/react/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/react/reference/type-aliases/MutationKey.md +++ b/docs/framework/react/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/react/reference/type-aliases/MutationMeta.md b/docs/framework/react/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/react/reference/type-aliases/MutationMeta.md +++ b/docs/framework/react/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/react/reference/type-aliases/MutationObserverResult.md b/docs/framework/react/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/MutationScope.md b/docs/framework/react/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/react/reference/type-aliases/MutationScope.md +++ b/docs/framework/react/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/react/reference/type-aliases/MutationStatus.md b/docs/framework/react/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/react/reference/type-aliases/NetworkMode.md b/docs/framework/react/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/react/reference/type-aliases/NetworkMode.md +++ b/docs/framework/react/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/react/reference/type-aliases/NotifyEventType.md b/docs/framework/react/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/react/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/react/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/react/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/react/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/react/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/react/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/react/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/react/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/react/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/react/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/react/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryBooleanOption.md b/docs/framework/react/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/react/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/react/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryFunction.md b/docs/framework/react/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/react/reference/type-aliases/QueryFunction.md +++ b/docs/framework/react/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryFunctionContext.md b/docs/framework/react/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/react/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/react/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryKey.md b/docs/framework/react/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/react/reference/type-aliases/QueryKey.md +++ b/docs/framework/react/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/react/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/react/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/react/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/react/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/react/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/react/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/react/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryMeta.md b/docs/framework/react/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/react/reference/type-aliases/QueryMeta.md +++ b/docs/framework/react/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/react/reference/type-aliases/QueryObserverResult.md b/docs/framework/react/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryPersister.md b/docs/framework/react/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/react/reference/type-aliases/QueryPersister.md +++ b/docs/framework/react/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/QueryStatus.md b/docs/framework/react/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/react/reference/type-aliases/StaleTime.md b/docs/framework/react/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/react/reference/type-aliases/StaleTime.md +++ b/docs/framework/react/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/react/reference/type-aliases/StaleTimeFunction.md b/docs/framework/react/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/react/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/react/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ThrowOnError.md b/docs/framework/react/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/UnsetMarker.md b/docs/framework/react/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/react/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/react/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/react/reference/type-aliases/WithRequired.md b/docs/framework/react/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/react/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/react/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/react/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/react/reference/type-aliases/dataTagSymbol.md b/docs/framework/react/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/react/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/react/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/react/reference/variables/dataTagErrorSymbol.md b/docs/framework/react/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/react/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/react/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/react/reference/variables/dataTagSymbol.md b/docs/framework/react/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/react/reference/variables/dataTagSymbol.md +++ b/docs/framework/react/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/react/reference/variables/unsetMarker.md b/docs/framework/react/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/react/reference/variables/unsetMarker.md +++ b/docs/framework/react/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/solid/reference/interfaces/CancelOptions.md b/docs/framework/solid/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/solid/reference/interfaces/CancelOptions.md +++ b/docs/framework/solid/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/solid/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md b/docs/framework/solid/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/solid/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/solid/reference/interfaces/FetchQueryOptions.md b/docs/framework/solid/reference/interfaces/FetchQueryOptions.md index 53681702fa..03d21811d0 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/solid/reference/interfaces/InfiniteData.md b/docs/framework/solid/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteData.md +++ b/docs/framework/solid/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/solid/reference/interfaces/InfiniteQueryPageParamsOptions.md index 355fc48ec9..f80c8d39d3 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InitialPageParam.md b/docs/framework/solid/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/solid/reference/interfaces/InitialPageParam.md +++ b/docs/framework/solid/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/solid/reference/interfaces/InvalidateOptions.md b/docs/framework/solid/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/solid/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/solid/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 0e1022e421..07ca1d938b 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md b/docs/framework/solid/reference/interfaces/QueryExecuteOptions.md index 47891676ea..4a2a040bdd 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/solid/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/solid/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/solid/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/solid/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/solid/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/solid/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/solid/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/solid/reference/interfaces/RefetchOptions.md b/docs/framework/solid/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md b/docs/framework/solid/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/solid/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/solid/reference/interfaces/Register.md +++ b/docs/framework/solid/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/solid/reference/interfaces/ResetOptions.md b/docs/framework/solid/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/solid/reference/interfaces/ResultOptions.md b/docs/framework/solid/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/solid/reference/interfaces/SetDataOptions.md b/docs/framework/solid/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/solid/reference/interfaces/SetDataOptions.md +++ b/docs/framework/solid/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/solid/reference/type-aliases/AnyDataTag.md b/docs/framework/solid/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/solid/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/solid/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/solid/reference/type-aliases/DataTag.md b/docs/framework/solid/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/solid/reference/type-aliases/DataTag.md +++ b/docs/framework/solid/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefaultError.md b/docs/framework/solid/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/solid/reference/type-aliases/DefaultError.md +++ b/docs/framework/solid/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/solid/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/solid/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/solid/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/solid/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FetchStatus.md b/docs/framework/solid/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/solid/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/solid/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/solid/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/solid/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/solid/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/solid/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/solid/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InferDataFromTag.md b/docs/framework/solid/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/solid/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/solid/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InferErrorFromTag.md b/docs/framework/solid/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/solid/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/solid/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/solid/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/solid/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/InitialDataFunction.md b/docs/framework/solid/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/solid/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/solid/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutateFunction.md b/docs/framework/solid/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md b/docs/framework/solid/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationFunction.md b/docs/framework/solid/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md b/docs/framework/solid/reference/type-aliases/MutationFunctionContext.md index 07574115fc..775cb55280 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/solid/reference/type-aliases/MutationKey.md b/docs/framework/solid/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/solid/reference/type-aliases/MutationKey.md +++ b/docs/framework/solid/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/solid/reference/type-aliases/MutationMeta.md b/docs/framework/solid/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/solid/reference/type-aliases/MutationMeta.md +++ b/docs/framework/solid/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/solid/reference/type-aliases/MutationObserverResult.md b/docs/framework/solid/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/MutationScope.md b/docs/framework/solid/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/solid/reference/type-aliases/MutationScope.md +++ b/docs/framework/solid/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/solid/reference/type-aliases/MutationStatus.md b/docs/framework/solid/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/solid/reference/type-aliases/NetworkMode.md b/docs/framework/solid/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/solid/reference/type-aliases/NetworkMode.md +++ b/docs/framework/solid/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/solid/reference/type-aliases/NotifyEventType.md b/docs/framework/solid/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/solid/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/solid/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/solid/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/solid/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/solid/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/solid/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/solid/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/solid/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/solid/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/solid/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/solid/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryBooleanOption.md b/docs/framework/solid/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/solid/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/solid/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryFunction.md b/docs/framework/solid/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/solid/reference/type-aliases/QueryFunction.md +++ b/docs/framework/solid/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryFunctionContext.md b/docs/framework/solid/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/solid/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/solid/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryKey.md b/docs/framework/solid/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/solid/reference/type-aliases/QueryKey.md +++ b/docs/framework/solid/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/solid/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/solid/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/solid/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/solid/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/solid/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/solid/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/solid/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryMeta.md b/docs/framework/solid/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/solid/reference/type-aliases/QueryMeta.md +++ b/docs/framework/solid/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/solid/reference/type-aliases/QueryObserverResult.md b/docs/framework/solid/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryPersister.md b/docs/framework/solid/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/solid/reference/type-aliases/QueryPersister.md +++ b/docs/framework/solid/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/QueryStatus.md b/docs/framework/solid/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/solid/reference/type-aliases/StaleTime.md b/docs/framework/solid/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/solid/reference/type-aliases/StaleTime.md +++ b/docs/framework/solid/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/solid/reference/type-aliases/StaleTimeFunction.md b/docs/framework/solid/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/solid/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/solid/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/ThrowOnError.md b/docs/framework/solid/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/UnsetMarker.md b/docs/framework/solid/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/solid/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/solid/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/solid/reference/type-aliases/WithRequired.md b/docs/framework/solid/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/solid/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/solid/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/solid/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/solid/reference/type-aliases/dataTagSymbol.md b/docs/framework/solid/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/solid/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/solid/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/solid/reference/variables/dataTagErrorSymbol.md b/docs/framework/solid/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/solid/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/solid/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/solid/reference/variables/dataTagSymbol.md b/docs/framework/solid/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/solid/reference/variables/dataTagSymbol.md +++ b/docs/framework/solid/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/solid/reference/variables/unsetMarker.md b/docs/framework/solid/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/solid/reference/variables/unsetMarker.md +++ b/docs/framework/solid/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/svelte/reference/interfaces/CancelOptions.md b/docs/framework/svelte/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/svelte/reference/interfaces/CancelOptions.md +++ b/docs/framework/svelte/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/svelte/reference/interfaces/DefaultOptions.md b/docs/framework/svelte/reference/interfaces/DefaultOptions.md index 4124204e04..c83954b7a9 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/svelte/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md b/docs/framework/svelte/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/svelte/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md b/docs/framework/svelte/reference/interfaces/FetchQueryOptions.md index ca3c25500f..c2359c0b63 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/svelte/reference/interfaces/InfiniteData.md b/docs/framework/svelte/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/svelte/reference/interfaces/InfiniteData.md +++ b/docs/framework/svelte/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/svelte/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InitialPageParam.md b/docs/framework/svelte/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/svelte/reference/interfaces/InitialPageParam.md +++ b/docs/framework/svelte/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/InvalidateOptions.md b/docs/framework/svelte/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/svelte/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 7c84660e7b..2c3cf90b0d 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 40e2a1ffe3..f2c59e68db 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:1225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1225) +Defined in: [packages/query-core/src/types.ts:1273](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1273) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/NotifyEvent.md b/docs/framework/svelte/reference/interfaces/NotifyEvent.md index 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/QueryClientConfig.md b/docs/framework/svelte/reference/interfaces/QueryClientConfig.md index 65cc5c4bce..5c7f2981c2 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md b/docs/framework/svelte/reference/interfaces/QueryExecuteOptions.md index 11a3860d80..3d8caa5328 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md b/docs/framework/svelte/reference/interfaces/QueryObserverOptions.md index d57f0e4b80..8722cbd51a 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/svelte/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/QueryOptions.md b/docs/framework/svelte/reference/interfaces/QueryOptions.md index fb3e168c5d..2dbbbc1bda 100644 --- a/docs/framework/svelte/reference/interfaces/QueryOptions.md +++ b/docs/framework/svelte/reference/interfaces/QueryOptions.md @@ -3,7 +3,7 @@ id: QueryOptions title: QueryOptions --- -Defined in: [packages/query-core/src/types.ts:243](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L243) +Defined in: [packages/query-core/src/types.ts:278](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L278) ## Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/RefetchOptions.md b/docs/framework/svelte/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md b/docs/framework/svelte/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/svelte/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/svelte/reference/interfaces/Register.md +++ b/docs/framework/svelte/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/svelte/reference/interfaces/ResetOptions.md b/docs/framework/svelte/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/ResultOptions.md b/docs/framework/svelte/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/svelte/reference/interfaces/SetDataOptions.md b/docs/framework/svelte/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/svelte/reference/interfaces/SetDataOptions.md +++ b/docs/framework/svelte/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/AnyDataTag.md b/docs/framework/svelte/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/svelte/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/svelte/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/DataTag.md b/docs/framework/svelte/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/svelte/reference/type-aliases/DataTag.md +++ b/docs/framework/svelte/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefaultError.md b/docs/framework/svelte/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/svelte/reference/type-aliases/DefaultError.md +++ b/docs/framework/svelte/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/svelte/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/svelte/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/svelte/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/svelte/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FetchStatus.md b/docs/framework/svelte/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/svelte/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/svelte/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/svelte/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/svelte/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/svelte/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/svelte/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/svelte/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InferDataFromTag.md b/docs/framework/svelte/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/svelte/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/svelte/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InferErrorFromTag.md b/docs/framework/svelte/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/svelte/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/svelte/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/svelte/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/InitialDataFunction.md b/docs/framework/svelte/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/svelte/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/svelte/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutateFunction.md b/docs/framework/svelte/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md b/docs/framework/svelte/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationFunction.md b/docs/framework/svelte/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md b/docs/framework/svelte/reference/type-aliases/MutationFunctionContext.md index 74c4e935c7..103c255061 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/MutationKey.md b/docs/framework/svelte/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationKey.md +++ b/docs/framework/svelte/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/svelte/reference/type-aliases/MutationMeta.md b/docs/framework/svelte/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationMeta.md +++ b/docs/framework/svelte/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md b/docs/framework/svelte/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/MutationScope.md b/docs/framework/svelte/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/svelte/reference/type-aliases/MutationScope.md +++ b/docs/framework/svelte/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/MutationStatus.md b/docs/framework/svelte/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/svelte/reference/type-aliases/NetworkMode.md b/docs/framework/svelte/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/svelte/reference/type-aliases/NetworkMode.md +++ b/docs/framework/svelte/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/svelte/reference/type-aliases/NotifyEventType.md b/docs/framework/svelte/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/svelte/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/svelte/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/svelte/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/svelte/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/svelte/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/svelte/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/svelte/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/svelte/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/svelte/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/svelte/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/svelte/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryBooleanOption.md b/docs/framework/svelte/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/svelte/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryFunction.md b/docs/framework/svelte/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryFunction.md +++ b/docs/framework/svelte/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryFunctionContext.md b/docs/framework/svelte/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/svelte/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryKey.md b/docs/framework/svelte/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryKey.md +++ b/docs/framework/svelte/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/svelte/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/svelte/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/svelte/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/svelte/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/svelte/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryMeta.md b/docs/framework/svelte/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryMeta.md +++ b/docs/framework/svelte/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md b/docs/framework/svelte/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryPersister.md b/docs/framework/svelte/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/svelte/reference/type-aliases/QueryPersister.md +++ b/docs/framework/svelte/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/QueryStatus.md b/docs/framework/svelte/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/svelte/reference/type-aliases/StaleTime.md b/docs/framework/svelte/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/svelte/reference/type-aliases/StaleTime.md +++ b/docs/framework/svelte/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/svelte/reference/type-aliases/StaleTimeFunction.md b/docs/framework/svelte/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/svelte/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/svelte/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/ThrowOnError.md b/docs/framework/svelte/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/UnsetMarker.md b/docs/framework/svelte/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/svelte/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/svelte/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/svelte/reference/type-aliases/WithRequired.md b/docs/framework/svelte/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/svelte/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/svelte/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/svelte/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/svelte/reference/type-aliases/dataTagSymbol.md b/docs/framework/svelte/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/svelte/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/svelte/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/svelte/reference/variables/dataTagErrorSymbol.md b/docs/framework/svelte/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/svelte/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/svelte/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/svelte/reference/variables/dataTagSymbol.md b/docs/framework/svelte/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/svelte/reference/variables/dataTagSymbol.md +++ b/docs/framework/svelte/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/svelte/reference/variables/unsetMarker.md b/docs/framework/svelte/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/svelte/reference/variables/unsetMarker.md +++ b/docs/framework/svelte/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/docs/framework/vue/reference/interfaces/CancelOptions.md b/docs/framework/vue/reference/interfaces/CancelOptions.md index 83eef7f40d..5fcd3aeed1 100644 --- a/docs/framework/vue/reference/interfaces/CancelOptions.md +++ b/docs/framework/vue/reference/interfaces/CancelOptions.md @@ -3,7 +3,10 @@ id: CancelOptions title: CancelOptions --- -Defined in: [packages/query-core/src/types.ts:1589](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1589) +Defined in: [packages/query-core/src/types.ts:1641](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1641) + +Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. +They are carried on the [CancelledError](../classes/CancelledError.md) that the cancelled fetch rejects with. ## Properties diff --git a/docs/framework/vue/reference/interfaces/DefaultOptions.md b/docs/framework/vue/reference/interfaces/DefaultOptions.md index c5a4cca9d3..8567eab85d 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:1575](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1575) +Defined in: [packages/query-core/src/types.ts:1623](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1623) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md b/docs/framework/vue/reference/interfaces/EnsureQueryDataOptions.md index 495860f19a..60b0f9d66d 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:634](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L634) +Defined in: [packages/query-core/src/types.ts:669](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L669) ## Deprecated diff --git a/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md b/docs/framework/vue/reference/interfaces/FetchNextPageOptions.md index 906ecf7e7b..c565615a44 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:758](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L758) +Defined in: [packages/query-core/src/types.ts:793](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L793) ## Extends diff --git a/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md b/docs/framework/vue/reference/interfaces/FetchPreviousPageOptions.md index 67e134be01..e152a36ff4 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:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) +Defined in: [packages/query-core/src/types.ts:805](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L805) ## Extends diff --git a/docs/framework/vue/reference/interfaces/FetchQueryOptions.md b/docs/framework/vue/reference/interfaces/FetchQueryOptions.md index 53681702fa..03d21811d0 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:615](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L615) +Defined in: [packages/query-core/src/types.ts:650](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L650) ## Deprecated diff --git a/docs/framework/vue/reference/interfaces/InfiniteData.md b/docs/framework/vue/reference/interfaces/InfiniteData.md index deaec4532f..c4a020f78d 100644 --- a/docs/framework/vue/reference/interfaces/InfiniteData.md +++ b/docs/framework/vue/reference/interfaces/InfiniteData.md @@ -3,7 +3,10 @@ id: InfiniteData title: InfiniteData --- -Defined in: [packages/query-core/src/types.ts:220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L220) +Defined in: [packages/query-core/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L251) + +The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. +`pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverBaseResult.md index 8a3b6d3d30..12e3305d3e 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:1024](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1024) +Defined in: [packages/query-core/src/types.ts:1059](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1059) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingErrorResult.md index 5537ec0820..15267fa39f 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:1101](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1101) +Defined in: [packages/query-core/src/types.ts:1136](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1136) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverLoadingResult.md index a5e5e5a5dc..b5777cd58d 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:1083](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1083) +Defined in: [packages/query-core/src/types.ts:1118](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1118) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverOptions.md index 894408e06c..dced173fa5 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:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L559) +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/InfiniteQueryObserverPendingResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPendingResult.md index 87f01ccae9..a7a62ac654 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:1066](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1066) +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/InfiniteQueryObserverPlaceholderResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverPlaceholderResult.md index 3d65b1ae0c..a11a0d1487 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:1153](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1153) +Defined in: [packages/query-core/src/types.ts:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverRefetchErrorResult.md index 965de016a6..be50a5dbb5 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:1119](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1119) +Defined in: [packages/query-core/src/types.ts:1154](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1154) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/InfiniteQueryObserverSuccessResult.md index 5044404fa7..702dd2f149 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:1135](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1135) +Defined in: [packages/query-core/src/types.ts:1170](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1170) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md b/docs/framework/vue/reference/interfaces/InfiniteQueryPageParamsOptions.md index 26c2d4d6a9..58bc7bb37b 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:371](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L371) +Defined in: [packages/query-core/src/types.ts:406](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L406) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InitialPageParam.md b/docs/framework/vue/reference/interfaces/InitialPageParam.md index de2139a43f..cbab047125 100644 --- a/docs/framework/vue/reference/interfaces/InitialPageParam.md +++ b/docs/framework/vue/reference/interfaces/InitialPageParam.md @@ -3,7 +3,7 @@ id: InitialPageParam title: InitialPageParam --- -Defined in: [packages/query-core/src/types.ts:360](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L360) +Defined in: [packages/query-core/src/types.ts:395](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L395) ## Extended by diff --git a/docs/framework/vue/reference/interfaces/InvalidateOptions.md b/docs/framework/vue/reference/interfaces/InvalidateOptions.md index a207356c18..f3c531a597 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:755](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L755) +Defined in: [packages/query-core/src/types.ts:790](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L790) ## Extends diff --git a/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md b/docs/framework/vue/reference/interfaces/InvalidateQueryFilters.md index b6dd5a861e..0fda4efb09 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:735](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L735) +Defined in: [packages/query-core/src/types.ts:770](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L770) 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 fc24904078..fe4b0abd88 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:1352](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1352) +Defined in: [packages/query-core/src/types.ts:1400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1400) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md b/docs/framework/vue/reference/interfaces/MutationObserverBaseResult.md index 00e1021964..81a5f9f36e 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:1403](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1403) +Defined in: [packages/query-core/src/types.ts:1451](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1451) 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 52c7132d5a..2dd23f9807 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:1510](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1510) +Defined in: [packages/query-core/src/types.ts:1558](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1558) 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 67f98f0942..db89035452 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:1468](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1468) +Defined in: [packages/query-core/src/types.ts:1516](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1516) 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 51c8547e28..c71e770163 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:1489](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1489) +Defined in: [packages/query-core/src/types.ts:1537](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1537) 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 0e1022e421..07ca1d938b 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:1335](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1335) +Defined in: [packages/query-core/src/types.ts:1383](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1383) ## Extends diff --git a/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/MutationObserverSuccessResult.md index 14a5486690..0c952324db 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:1531](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1531) +Defined in: [packages/query-core/src/types.ts:1579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1579) 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 6303b2bb65..cc4c541c3c 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:1608](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1608) +Defined in: [packages/query-core/src/types.ts:1665](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1665) ## Properties diff --git a/docs/framework/vue/reference/interfaces/QueryClientConfig.md b/docs/framework/vue/reference/interfaces/QueryClientConfig.md index b207c49a90..1fe03b033e 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:1563](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1563) +Defined in: [packages/query-core/src/types.ts:1611](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1611) ## Properties diff --git a/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md b/docs/framework/vue/reference/interfaces/QueryExecuteOptions.md index 47891676ea..4a2a040bdd 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:594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L594) +Defined in: [packages/query-core/src/types.ts:629](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L629) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md b/docs/framework/vue/reference/interfaces/QueryObserverBaseResult.md index 95abf673e0..8cecb4a76b 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:787](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L787) +Defined in: [packages/query-core/src/types.ts:822](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L822) ## Extended by diff --git a/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md b/docs/framework/vue/reference/interfaces/QueryObserverLoadingErrorResult.md index 2c0254014d..3abd99decd 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:946](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L946) +Defined in: [packages/query-core/src/types.ts:981](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L981) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md b/docs/framework/vue/reference/interfaces/QueryObserverLoadingResult.md index d4fe735d5c..d57b0d4c77 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:930](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L930) +Defined in: [packages/query-core/src/types.ts:965](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L965) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverOptions.md b/docs/framework/vue/reference/interfaces/QueryObserverOptions.md index 40c10b2503..e80f181152 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:400](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L400) +Defined in: [packages/query-core/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L435) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md b/docs/framework/vue/reference/interfaces/QueryObserverPendingResult.md index 2b6e46e2d9..6ded014b09 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:915](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L915) +Defined in: [packages/query-core/src/types.ts:950](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L950) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md b/docs/framework/vue/reference/interfaces/QueryObserverPlaceholderResult.md index c6c637916d..0b164abe2f 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:994](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L994) +Defined in: [packages/query-core/src/types.ts:1029](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1029) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md b/docs/framework/vue/reference/interfaces/QueryObserverRefetchErrorResult.md index e24cf9b520..a0385a9c0f 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:962](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L962) +Defined in: [packages/query-core/src/types.ts:997](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L997) ## Extends diff --git a/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md b/docs/framework/vue/reference/interfaces/QueryObserverSuccessResult.md index 0e1040c026..47fd3860c3 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:978](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L978) +Defined in: [packages/query-core/src/types.ts:1013](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1013) ## Extends diff --git a/docs/framework/vue/reference/interfaces/RefetchOptions.md b/docs/framework/vue/reference/interfaces/RefetchOptions.md index 22ef813d38..d9496dd4c8 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:724](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L724) +Defined in: [packages/query-core/src/types.ts:759](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L759) ## Extends diff --git a/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md b/docs/framework/vue/reference/interfaces/RefetchQueryFilters.md index 864f5c14e1..813590b6fa 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:751](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L751) +Defined in: [packages/query-core/src/types.ts:786](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L786) 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/Register.md b/docs/framework/vue/reference/interfaces/Register.md index 4f442442b4..3670e1d159 100644 --- a/docs/framework/vue/reference/interfaces/Register.md +++ b/docs/framework/vue/reference/interfaces/Register.md @@ -3,4 +3,24 @@ id: Register title: Register --- -Defined in: [packages/query-core/src/types.ts:37](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L37) +Defined in: [packages/query-core/src/types.ts:56](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L56) + +The interface to augment via declaration merging to override Query's default types repository-wide. +Each field it declares replaces the default of the matching type: `defaultError` for [DefaultError](../type-aliases/DefaultError.md), +`queryKey` for [QueryKey](../type-aliases/QueryKey.md), `mutationKey` for [MutationKey](../type-aliases/MutationKey.md), `queryMeta` for [QueryMeta](../type-aliases/QueryMeta.md) and +`mutationMeta` for [MutationMeta](../type-aliases/MutationMeta.md). Leave a field out to keep that type's default. +Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, +`@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, +`@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` +works too and covers every adapter at once. + +## Example + +```ts +// Use the module you installed — here, the React adapter. +declare module '@tanstack/react-query' { + interface Register { + defaultError: AxiosError + } +} +``` diff --git a/docs/framework/vue/reference/interfaces/ResetOptions.md b/docs/framework/vue/reference/interfaces/ResetOptions.md index 0679cafaad..9a110d07ec 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:756](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L756) +Defined in: [packages/query-core/src/types.ts:791](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L791) ## Extends diff --git a/docs/framework/vue/reference/interfaces/ResultOptions.md b/docs/framework/vue/reference/interfaces/ResultOptions.md index 5025179c46..a8392507df 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:714](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L714) +Defined in: [packages/query-core/src/types.ts:749](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L749) ## Extended by diff --git a/docs/framework/vue/reference/interfaces/SetDataOptions.md b/docs/framework/vue/reference/interfaces/SetDataOptions.md index a4207d6e55..ef221abbaf 100644 --- a/docs/framework/vue/reference/interfaces/SetDataOptions.md +++ b/docs/framework/vue/reference/interfaces/SetDataOptions.md @@ -3,7 +3,11 @@ id: SetDataOptions title: SetDataOptions --- -Defined in: [packages/query-core/src/types.ts:1594](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1594) +Defined in: [packages/query-core/src/types.ts:1651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1651) + +Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. +`updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; +omit it to use the current time. ## Properties diff --git a/docs/framework/vue/reference/type-aliases/AnyDataTag.md b/docs/framework/vue/reference/type-aliases/AnyDataTag.md index 90692353fc..2b1f57e75e 100644 --- a/docs/framework/vue/reference/type-aliases/AnyDataTag.md +++ b/docs/framework/vue/reference/type-aliases/AnyDataTag.md @@ -7,7 +7,7 @@ title: AnyDataTag type AnyDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:67](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L67) +Defined in: [packages/query-core/src/types.ts:94](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L94) ## Properties diff --git a/docs/framework/vue/reference/type-aliases/DataTag.md b/docs/framework/vue/reference/type-aliases/DataTag.md index 904ca12446..92b59fc965 100644 --- a/docs/framework/vue/reference/type-aliases/DataTag.md +++ b/docs/framework/vue/reference/type-aliases/DataTag.md @@ -7,7 +7,7 @@ title: DataTag type DataTag = TType extends AnyDataTag ? TType : TType & object; ``` -Defined in: [packages/query-core/src/types.ts:71](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L71) +Defined in: [packages/query-core/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L98) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefaultError.md b/docs/framework/vue/reference/type-aliases/DefaultError.md index da9f615482..1b6571b9a2 100644 --- a/docs/framework/vue/reference/type-aliases/DefaultError.md +++ b/docs/framework/vue/reference/type-aliases/DefaultError.md @@ -7,4 +7,7 @@ title: DefaultError type DefaultError = Register extends object ? TError : Error; ``` -Defined in: [packages/query-core/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L45) +Defined in: [packages/query-core/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L68) + +The error type used wherever an error is not given an explicit type parameter. +Defaults to `Error`; declare `defaultError` on [Register](../interfaces/Register.md) to change it everywhere at once. diff --git a/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md b/docs/framework/vue/reference/type-aliases/DefaultedInfiniteQueryObserverOptions.md index 726fc8c79c..fc8fcb9cd5 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:577](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L577) +Defined in: [packages/query-core/src/types.ts:612](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L612) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md b/docs/framework/vue/reference/type-aliases/DefaultedQueryObserverOptions.md index 27bcabb8f6..e1ba93f3f1 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:548](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L548) +Defined in: [packages/query-core/src/types.ts:583](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L583) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/DefinedInfiniteQueryObserverResult.md index 26c748c866..dee7b2504c 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:1171](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1171) +Defined in: [packages/query-core/src/types.ts:1206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1206) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/DefinedQueryObserverResult.md index 1cb65091df..c75c8c7758 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:1010](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1010) +Defined in: [packages/query-core/src/types.ts:1045](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1045) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md b/docs/framework/vue/reference/type-aliases/EnsureInfiniteQueryDataOptions.md index df4f05d659..306adda903 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:651](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L651) +Defined in: [packages/query-core/src/types.ts:686](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L686) ## Type Declaration diff --git a/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md b/docs/framework/vue/reference/type-aliases/FetchInfiniteQueryOptions.md index 6a198f37f1..2828402122 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:695](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L695) +Defined in: [packages/query-core/src/types.ts:730](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L730) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FetchStatus.md b/docs/framework/vue/reference/type-aliases/FetchStatus.md index fc74a092b8..bee5453ec5 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:785](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L785) +Defined in: [packages/query-core/src/types.ts:820](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L820) diff --git a/docs/framework/vue/reference/type-aliases/GetNextPageParamFunction.md b/docs/framework/vue/reference/type-aliases/GetNextPageParamFunction.md index b3fcb66813..c45a3d7ed1 100644 --- a/docs/framework/vue/reference/type-aliases/GetNextPageParamFunction.md +++ b/docs/framework/vue/reference/type-aliases/GetNextPageParamFunction.md @@ -7,7 +7,7 @@ title: GetNextPageParamFunction type GetNextPageParamFunction = (lastPage: TQueryFnData, allPages: TQueryFnData[], lastPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L213) +Defined in: [packages/query-core/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L240) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/GetPreviousPageParamFunction.md b/docs/framework/vue/reference/type-aliases/GetPreviousPageParamFunction.md index 81d420de9c..dd26d2e9c1 100644 --- a/docs/framework/vue/reference/type-aliases/GetPreviousPageParamFunction.md +++ b/docs/framework/vue/reference/type-aliases/GetPreviousPageParamFunction.md @@ -7,7 +7,7 @@ title: GetPreviousPageParamFunction type GetPreviousPageParamFunction = (firstPage: TQueryFnData, allPages: TQueryFnData[], firstPageParam: TPageParam, allPageParams: TPageParam[]) => TPageParam | undefined | null; ``` -Defined in: [packages/query-core/src/types.ts:205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L205) +Defined in: [packages/query-core/src/types.ts:232](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L232) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InferDataFromTag.md b/docs/framework/vue/reference/type-aliases/InferDataFromTag.md index 09a15ca4b1..853bf7b1ec 100644 --- a/docs/framework/vue/reference/type-aliases/InferDataFromTag.md +++ b/docs/framework/vue/reference/type-aliases/InferDataFromTag.md @@ -7,7 +7,7 @@ title: InferDataFromTag type InferDataFromTag = TTaggedQueryKey extends DataTag ? TaggedValue : TQueryFnData; ``` -Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) +Defined in: [packages/query-core/src/types.ts:117](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L117) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InferErrorFromTag.md b/docs/framework/vue/reference/type-aliases/InferErrorFromTag.md index cd94e4b5c3..01a0a9e961 100644 --- a/docs/framework/vue/reference/type-aliases/InferErrorFromTag.md +++ b/docs/framework/vue/reference/type-aliases/InferErrorFromTag.md @@ -7,7 +7,7 @@ title: InferErrorFromTag type InferErrorFromTag = TTaggedQueryKey extends DataTag ? TaggedError extends UnsetMarker ? TError : TaggedError : TError; ``` -Defined in: [packages/query-core/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L95) +Defined in: [packages/query-core/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L122) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md b/docs/framework/vue/reference/type-aliases/InfiniteQueryExecuteOptions.md index fe7e832880..4e0bc1c510 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:674](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L674) +Defined in: [packages/query-core/src/types.ts:709](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L709) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md b/docs/framework/vue/reference/type-aliases/InfiniteQueryObserverResult.md index 6c05ab793f..182fa547e6 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:1178](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1178) +Defined in: [packages/query-core/src/types.ts:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/InitialDataFunction.md b/docs/framework/vue/reference/type-aliases/InitialDataFunction.md index 1d2729b4e4..9c486b0e67 100644 --- a/docs/framework/vue/reference/type-aliases/InitialDataFunction.md +++ b/docs/framework/vue/reference/type-aliases/InitialDataFunction.md @@ -7,7 +7,7 @@ title: InitialDataFunction type InitialDataFunction = () => T | undefined; ``` -Defined in: [packages/query-core/src/types.ts:179](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L179) +Defined in: [packages/query-core/src/types.ts:206](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L206) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutateFunction.md b/docs/framework/vue/reference/type-aliases/MutateFunction.md index dba3e5fb2a..6beae3c478 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:1394](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1394) +Defined in: [packages/query-core/src/types.ts:1442](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1442) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md b/docs/framework/vue/reference/type-aliases/MutateFunctionRest.md index d14b813e86..bc632b5abc 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:1379](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1379) +Defined in: [packages/query-core/src/types.ts:1427](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1427) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationFunction.md b/docs/framework/vue/reference/type-aliases/MutationFunction.md index 5ac7a65ff2..1e812e9c4d 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:1220](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1220) +Defined in: [packages/query-core/src/types.ts:1268](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1268) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md b/docs/framework/vue/reference/type-aliases/MutationFunctionContext.md index 07574115fc..775cb55280 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:1213](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1213) +Defined in: [packages/query-core/src/types.ts:1261](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1261) ## Properties diff --git a/docs/framework/vue/reference/type-aliases/MutationKey.md b/docs/framework/vue/reference/type-aliases/MutationKey.md index f592a35064..32251c965f 100644 --- a/docs/framework/vue/reference/type-aliases/MutationKey.md +++ b/docs/framework/vue/reference/type-aliases/MutationKey.md @@ -7,4 +7,7 @@ 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:1188](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1188) +Defined in: [packages/query-core/src/types.ts:1227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1227) + +The type of a mutation key — the serializable array used to identify and filter mutations. +Defaults to `ReadonlyArray`; declare `mutationKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/vue/reference/type-aliases/MutationMeta.md b/docs/framework/vue/reference/type-aliases/MutationMeta.md index 2cbee82e82..a99af23f96 100644 --- a/docs/framework/vue/reference/type-aliases/MutationMeta.md +++ b/docs/framework/vue/reference/type-aliases/MutationMeta.md @@ -7,4 +7,7 @@ title: MutationMeta type MutationMeta = Register extends object ? TMutationMeta extends Record ? TMutationMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:1205](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1205) +Defined in: [packages/query-core/src/types.ts:1253](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1253) + +The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `mutationMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/vue/reference/type-aliases/MutationObserverResult.md b/docs/framework/vue/reference/type-aliases/MutationObserverResult.md index 38d909e76f..eec68534c7 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:1552](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1552) +Defined in: [packages/query-core/src/types.ts:1600](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1600) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/MutationScope.md b/docs/framework/vue/reference/type-aliases/MutationScope.md index a4c9da417a..3e83bcfefb 100644 --- a/docs/framework/vue/reference/type-aliases/MutationScope.md +++ b/docs/framework/vue/reference/type-aliases/MutationScope.md @@ -7,7 +7,11 @@ title: MutationScope type MutationScope = object; ``` -Defined in: [packages/query-core/src/types.ts:1201](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1201) +Defined in: [packages/query-core/src/types.ts:1245](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1245) + +Groups mutations so they run one after another instead of in parallel. +Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` +state and resume automatically when their turn comes. Mutations with no scope always run in parallel. ## Properties diff --git a/docs/framework/vue/reference/type-aliases/MutationStatus.md b/docs/framework/vue/reference/type-aliases/MutationStatus.md index 6f48a359df..b16ef5fc35 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:1199](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1199) +Defined in: [packages/query-core/src/types.ts:1238](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1238) diff --git a/docs/framework/vue/reference/type-aliases/NetworkMode.md b/docs/framework/vue/reference/type-aliases/NetworkMode.md index f9b2f7a996..a727cb0653 100644 --- a/docs/framework/vue/reference/type-aliases/NetworkMode.md +++ b/docs/framework/vue/reference/type-aliases/NetworkMode.md @@ -7,4 +7,4 @@ title: NetworkMode type NetworkMode = "online" | "always" | "offlineFirst"; ``` -Defined in: [packages/query-core/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L234) +Defined in: [packages/query-core/src/types.ts:269](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L269) diff --git a/docs/framework/vue/reference/type-aliases/NotifyEventType.md b/docs/framework/vue/reference/type-aliases/NotifyEventType.md index 2a0ed02aae..01f118fde2 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:1599](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1599) +Defined in: [packages/query-core/src/types.ts:1656](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1656) diff --git a/docs/framework/vue/reference/type-aliases/NotifyOnChangeProps.md b/docs/framework/vue/reference/type-aliases/NotifyOnChangeProps.md index 5879c9bb22..9cd620e79d 100644 --- a/docs/framework/vue/reference/type-aliases/NotifyOnChangeProps.md +++ b/docs/framework/vue/reference/type-aliases/NotifyOnChangeProps.md @@ -14,4 +14,4 @@ type NotifyOnChangeProps = | undefined; ``` -Defined in: [packages/query-core/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L237) +Defined in: [packages/query-core/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L272) diff --git a/docs/framework/vue/reference/type-aliases/PlaceholderDataFunction.md b/docs/framework/vue/reference/type-aliases/PlaceholderDataFunction.md index e1828d8528..456b9e6a64 100644 --- a/docs/framework/vue/reference/type-aliases/PlaceholderDataFunction.md +++ b/docs/framework/vue/reference/type-aliases/PlaceholderDataFunction.md @@ -9,7 +9,7 @@ type PlaceholderDataFunction = (pre | undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:184](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L184) +Defined in: [packages/query-core/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L211) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueriesPlaceholderDataFunction.md b/docs/framework/vue/reference/type-aliases/QueriesPlaceholderDataFunction.md index 18b17fa62f..91b1778650 100644 --- a/docs/framework/vue/reference/type-aliases/QueriesPlaceholderDataFunction.md +++ b/docs/framework/vue/reference/type-aliases/QueriesPlaceholderDataFunction.md @@ -7,7 +7,7 @@ title: QueriesPlaceholderDataFunction type QueriesPlaceholderDataFunction = (previousData: undefined, previousQuery: undefined) => TQueryData | undefined; ``` -Defined in: [packages/query-core/src/types.ts:194](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L194) +Defined in: [packages/query-core/src/types.ts:221](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L221) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryBooleanOption.md b/docs/framework/vue/reference/type-aliases/QueryBooleanOption.md index 0e33c579f0..c992ec0c63 100644 --- a/docs/framework/vue/reference/type-aliases/QueryBooleanOption.md +++ b/docs/framework/vue/reference/type-aliases/QueryBooleanOption.md @@ -9,7 +9,7 @@ type QueryBooleanOption = | (query: Query) => boolean; ``` -Defined in: [packages/query-core/src/types.ts:123](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L123) +Defined in: [packages/query-core/src/types.ts:150](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L150) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryFunction.md b/docs/framework/vue/reference/type-aliases/QueryFunction.md index 154e95e570..e1682277f1 100644 --- a/docs/framework/vue/reference/type-aliases/QueryFunction.md +++ b/docs/framework/vue/reference/type-aliases/QueryFunction.md @@ -7,7 +7,7 @@ title: QueryFunction type QueryFunction = (context: QueryFunctionContext) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L103) +Defined in: [packages/query-core/src/types.ts:130](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L130) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryFunctionContext.md b/docs/framework/vue/reference/type-aliases/QueryFunctionContext.md index 7675cfe13b..6ea82d0aee 100644 --- a/docs/framework/vue/reference/type-aliases/QueryFunctionContext.md +++ b/docs/framework/vue/reference/type-aliases/QueryFunctionContext.md @@ -7,7 +7,7 @@ title: QueryFunctionContext type QueryFunctionContext = [TPageParam] extends [never] ? object : object; ``` -Defined in: [packages/query-core/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L149) +Defined in: [packages/query-core/src/types.ts:176](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L176) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryKey.md b/docs/framework/vue/reference/type-aliases/QueryKey.md index 1a3f34cde1..51447f90fb 100644 --- a/docs/framework/vue/reference/type-aliases/QueryKey.md +++ b/docs/framework/vue/reference/type-aliases/QueryKey.md @@ -7,4 +7,7 @@ title: QueryKey type QueryKey = Register extends object ? TQueryKey extends ReadonlyArray ? TQueryKey : TQueryKey extends unknown[] ? TQueryKey : ReadonlyArray : ReadonlyArray; ``` -Defined in: [packages/query-core/src/types.ts:51](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L51) +Defined in: [packages/query-core/src/types.ts:78](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L78) + +The type of a query key — the serializable array that identifies a query in the cache. +Defaults to `ReadonlyArray`; declare `queryKey` on [Register](../interfaces/Register.md) to narrow it repository-wide. diff --git a/docs/framework/vue/reference/type-aliases/QueryKeyHashFunction.md b/docs/framework/vue/reference/type-aliases/QueryKeyHashFunction.md index 42526d2727..6f77c8928b 100644 --- a/docs/framework/vue/reference/type-aliases/QueryKeyHashFunction.md +++ b/docs/framework/vue/reference/type-aliases/QueryKeyHashFunction.md @@ -7,7 +7,7 @@ title: QueryKeyHashFunction type QueryKeyHashFunction = (queryKey: TQueryKey) => string; ``` -Defined in: [packages/query-core/src/types.ts:200](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L200) +Defined in: [packages/query-core/src/types.ts:227](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L227) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryKeyWithDataTag.md b/docs/framework/vue/reference/type-aliases/QueryKeyWithDataTag.md index 810e6d2881..02b78b2880 100644 --- a/docs/framework/vue/reference/type-aliases/QueryKeyWithDataTag.md +++ b/docs/framework/vue/reference/type-aliases/QueryKeyWithDataTag.md @@ -7,7 +7,7 @@ title: QueryKeyWithDataTag type QueryKeyWithDataTag = object; ``` -Defined in: [packages/query-core/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L82) +Defined in: [packages/query-core/src/types.ts:109](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L109) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryMeta.md b/docs/framework/vue/reference/type-aliases/QueryMeta.md index 21307cac30..25a245699b 100644 --- a/docs/framework/vue/reference/type-aliases/QueryMeta.md +++ b/docs/framework/vue/reference/type-aliases/QueryMeta.md @@ -7,4 +7,7 @@ title: QueryMeta type QueryMeta = Register extends object ? TQueryMeta extends Record ? TQueryMeta : Record : Record; ``` -Defined in: [packages/query-core/src/types.ts:225](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L225) +Defined in: [packages/query-core/src/types.ts:260](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L260) + +The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and +cache-level handlers. Defaults to `Record`; declare `queryMeta` on [Register](../interfaces/Register.md) to narrow it. diff --git a/docs/framework/vue/reference/type-aliases/QueryObserverResult.md b/docs/framework/vue/reference/type-aliases/QueryObserverResult.md index 0ee2201378..0513205476 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:1017](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1017) +Defined in: [packages/query-core/src/types.ts:1052](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L1052) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryPersister.md b/docs/framework/vue/reference/type-aliases/QueryPersister.md index df1d58302a..8eedf698a9 100644 --- a/docs/framework/vue/reference/type-aliases/QueryPersister.md +++ b/docs/framework/vue/reference/type-aliases/QueryPersister.md @@ -7,7 +7,7 @@ title: QueryPersister type QueryPersister = [TPageParam] extends [never] ? (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise : (queryFn: QueryFunction, context: QueryFunctionContext, query: Query) => T | Promise; ``` -Defined in: [packages/query-core/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L133) +Defined in: [packages/query-core/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L160) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/QueryStatus.md b/docs/framework/vue/reference/type-aliases/QueryStatus.md index 4717b046ad..603fb3c23f 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:783](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L783) +Defined in: [packages/query-core/src/types.ts:818](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L818) diff --git a/docs/framework/vue/reference/type-aliases/StaleTime.md b/docs/framework/vue/reference/type-aliases/StaleTime.md index 8090ff5da3..a16040761e 100644 --- a/docs/framework/vue/reference/type-aliases/StaleTime.md +++ b/docs/framework/vue/reference/type-aliases/StaleTime.md @@ -7,4 +7,4 @@ title: StaleTime type StaleTime = number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L110) +Defined in: [packages/query-core/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L137) diff --git a/docs/framework/vue/reference/type-aliases/StaleTimeFunction.md b/docs/framework/vue/reference/type-aliases/StaleTimeFunction.md index 3e57ff0061..ec4e9f7b98 100644 --- a/docs/framework/vue/reference/type-aliases/StaleTimeFunction.md +++ b/docs/framework/vue/reference/type-aliases/StaleTimeFunction.md @@ -9,7 +9,7 @@ type StaleTimeFunction = | (query: Query) => number | "static"; ``` -Defined in: [packages/query-core/src/types.ts:113](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L113) +Defined in: [packages/query-core/src/types.ts:140](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L140) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/ThrowOnError.md b/docs/framework/vue/reference/type-aliases/ThrowOnError.md index d9498dcd94..b4a3916b8c 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:388](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L388) +Defined in: [packages/query-core/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L423) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/UnsetMarker.md b/docs/framework/vue/reference/type-aliases/UnsetMarker.md index 8b9c14e190..83356a74e5 100644 --- a/docs/framework/vue/reference/type-aliases/UnsetMarker.md +++ b/docs/framework/vue/reference/type-aliases/UnsetMarker.md @@ -7,4 +7,4 @@ title: UnsetMarker type UnsetMarker = typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:66](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L66) +Defined in: [packages/query-core/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L93) diff --git a/docs/framework/vue/reference/type-aliases/WithRequired.md b/docs/framework/vue/reference/type-aliases/WithRequired.md index e81802aa38..a12a324a98 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:544](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L544) +Defined in: [packages/query-core/src/types.ts:579](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L579) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/dataTagErrorSymbol.md b/docs/framework/vue/reference/type-aliases/dataTagErrorSymbol.md index 26148a94d6..03cc2c00ee 100644 --- a/docs/framework/vue/reference/type-aliases/dataTagErrorSymbol.md +++ b/docs/framework/vue/reference/type-aliases/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol type dataTagErrorSymbol = typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/vue/reference/type-aliases/dataTagSymbol.md b/docs/framework/vue/reference/type-aliases/dataTagSymbol.md index 0012c108cc..f2228d88a3 100644 --- a/docs/framework/vue/reference/type-aliases/dataTagSymbol.md +++ b/docs/framework/vue/reference/type-aliases/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol type dataTagSymbol = typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/vue/reference/variables/dataTagErrorSymbol.md b/docs/framework/vue/reference/variables/dataTagErrorSymbol.md index 20bab62fb0..90d0e92ca9 100644 --- a/docs/framework/vue/reference/variables/dataTagErrorSymbol.md +++ b/docs/framework/vue/reference/variables/dataTagErrorSymbol.md @@ -7,4 +7,4 @@ title: dataTagErrorSymbol const dataTagErrorSymbol: typeof dataTagErrorSymbol; ``` -Defined in: [packages/query-core/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L63) +Defined in: [packages/query-core/src/types.ts:90](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L90) diff --git a/docs/framework/vue/reference/variables/dataTagSymbol.md b/docs/framework/vue/reference/variables/dataTagSymbol.md index 83dd68a56e..0eb15cc3bc 100644 --- a/docs/framework/vue/reference/variables/dataTagSymbol.md +++ b/docs/framework/vue/reference/variables/dataTagSymbol.md @@ -7,4 +7,4 @@ title: dataTagSymbol const dataTagSymbol: typeof dataTagSymbol; ``` -Defined in: [packages/query-core/src/types.ts:61](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L61) +Defined in: [packages/query-core/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L88) diff --git a/docs/framework/vue/reference/variables/unsetMarker.md b/docs/framework/vue/reference/variables/unsetMarker.md index d19ee65b38..c58e846547 100644 --- a/docs/framework/vue/reference/variables/unsetMarker.md +++ b/docs/framework/vue/reference/variables/unsetMarker.md @@ -7,4 +7,4 @@ title: unsetMarker const unsetMarker: typeof unsetMarker; ``` -Defined in: [packages/query-core/src/types.ts:65](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L65) +Defined in: [packages/query-core/src/types.ts:92](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L92) diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts index 7d91dc1e6b..2fa8bf410e 100644 --- a/packages/query-core/src/types.ts +++ b/packages/query-core/src/types.ts @@ -34,6 +34,25 @@ export type Override = { : TTargetA[AKey] } +/** + * The interface to augment via declaration merging to override Query's default types repository-wide. + * Each field it declares replaces the default of the matching type: `defaultError` for {@link DefaultError}, + * `queryKey` for {@link QueryKey}, `mutationKey` for {@link MutationKey}, `queryMeta` for {@link QueryMeta} and + * `mutationMeta` for {@link MutationMeta}. Leave a field out to keep that type's default. + * Augment the module you install — `@tanstack/react-query`, `@tanstack/vue-query`, + * `@tanstack/solid-query`, `@tanstack/svelte-query`, `@tanstack/preact-query`, + * `@tanstack/angular-query-experimental` or `@tanstack/lit-query`. Augmenting `@tanstack/query-core` + * works too and covers every adapter at once. + * @example + * ```ts + * // Use the module you installed — here, the React adapter. + * declare module '@tanstack/react-query' { + * interface Register { + * defaultError: AxiosError + * } + * } + * ``` + */ export interface Register { // defaultError: Error // queryMeta: Record @@ -42,12 +61,20 @@ export interface Register { // mutationKey: ReadonlyArray } +/** + * The error type used wherever an error is not given an explicit type parameter. + * Defaults to `Error`; declare `defaultError` on {@link Register} to change it everywhere at once. + */ export type DefaultError = Register extends { defaultError: infer TError } ? TError : Error +/** + * The type of a query key — the serializable array that identifies a query in the cache. + * Defaults to `ReadonlyArray`; declare `queryKey` on {@link Register} to narrow it repository-wide. + */ export type QueryKey = Register extends { queryKey: infer TQueryKey } @@ -217,11 +244,19 @@ export type GetNextPageParamFunction = ( allPageParams: Array, ) => TPageParam | undefined | null +/** + * The data shape of an infinite query: every page fetched so far, plus the page param each one was fetched with. + * `pages` and `pageParams` are index-aligned — `pageParams[i]` is the param that produced `pages[i]`. + */ export interface InfiniteData { pages: Array pageParams: Array } +/** + * The type of the `meta` object that can be attached to a query and read back from `queryFn`, callbacks and + * cache-level handlers. Defaults to `Record`; declare `queryMeta` on {@link Register} to narrow it. + */ export type QueryMeta = Register extends { queryMeta: infer TQueryMeta } @@ -1185,6 +1220,10 @@ export type InfiniteQueryObserverResult< | InfiniteQueryObserverPendingResult | InfiniteQueryObserverPlaceholderResult +/** + * The type of a mutation key — the serializable array used to identify and filter mutations. + * Defaults to `ReadonlyArray`; declare `mutationKey` on {@link Register} to narrow it repository-wide. + */ export type MutationKey = Register extends { mutationKey: infer TMutationKey } @@ -1198,10 +1237,19 @@ export type MutationKey = Register extends { /** @inline */ export type MutationStatus = 'idle' | 'pending' | 'success' | 'error' +/** + * Groups mutations so they run one after another instead of in parallel. + * Mutations that share the same `id` form a queue: while one is running, the others wait in `isPaused: true` + * state and resume automatically when their turn comes. Mutations with no scope always run in parallel. + */ export type MutationScope = { id: string } +/** + * The type of the `meta` object that can be attached to a mutation and read back from `mutationFn`, callbacks and + * cache-level handlers. Defaults to `Record`; declare `mutationMeta` on {@link Register} to narrow it. + */ export type MutationMeta = Register extends { mutationMeta: infer TMutationMeta } @@ -1586,11 +1634,20 @@ export interface DefaultOptions { dehydrate?: DehydrateOptions } +/** + * Options for cancelling an in-flight fetch, e.g. via `query.cancel()`. + * They are carried on the {@link CancelledError} that the cancelled fetch rejects with. + */ export interface CancelOptions { revert?: boolean silent?: boolean } +/** + * Options for writing data into the cache, e.g. via `queryClient.setQueryData()`. + * `updatedAt` overrides the timestamp the data is recorded with, which is what staleness is measured from; + * omit it to use the current time. + */ export interface SetDataOptions { updatedAt?: number }