Class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

constructor

• new QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>(client, options): QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

• Type Parameters

  • TQueryFnData = unknown
  • TError = Error
  • TData = TQueryFnData
  • TQueryData = TQueryFnData
  • TQueryKey extends QueryKey = QueryKey

  Parameters

  • client: QueryClient
  • options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

  Returns QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey>

options

destroy

• destroy(): void

• Returns void

fetchOptimistic

• fetchOptimistic(options): Promise<QueryObserverResult<TData, TError>>

• Parameters

  • options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>

  Returns Promise<QueryObserverResult<TData, TError>>

getCurrentQuery

• getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>

• Returns Query<TQueryFnData, TError, TQueryData, TQueryKey>

getCurrentResult

• getCurrentResult(): QueryObserverResult<TData, TError>

• Returns QueryObserverResult<TData, TError>

getOptimisticResult

• getOptimisticResult(options): QueryObserverResult<TData, TError>

• Parameters

  • options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

  Returns QueryObserverResult<TData, TError>

onQueryUpdate

• onQueryUpdate(): void

• Returns void

refetch

• refetch(__namedParameters?): Promise<QueryObserverResult<TData, TError>>

• Parameters

  • Optional__namedParameters: RefetchOptions

  Returns Promise<QueryObserverResult<TData, TError>>

setOptions

• setOptions(options, notifyOptions?): void

• Parameters

  • options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, never>
  • OptionalnotifyOptions: NotifyOptions

  Returns void

shouldFetchOnReconnect

• shouldFetchOnReconnect(): boolean

• Returns boolean

shouldFetchOnWindowFocus

• shouldFetchOnWindowFocus(): boolean

• Returns boolean

trackProp

• trackProp(key): void

• Parameters

  • key:
        | "data"
        | "error"
        | "status"
        | "isPaused"
        | "isError"
        | "isPending"
        | "isLoading"
        | "isLoadingError"
        | "isRefetchError"
        | "isSuccess"
        | "dataUpdatedAt"
        | "errorUpdatedAt"
        | "failureCount"
        | "failureReason"
        | "errorUpdateCount"
        | "isFetched"
        | "isFetchedAfterMount"
        | "isFetching"
        | "isInitialLoading"
        | "isPlaceholderData"
        | "isRefetching"
        | "isStale"
        | "refetch"
        | "fetchStatus"

  Returns void

trackResult

• trackResult(result, onPropTracked?): QueryObserverResult<TData, TError>

• Parameters

  • result: QueryObserverResult<TData, TError>
  • OptionalonPropTracked: ((key:
        | "data"
        | "error"
        | "status"
        | "isPaused"
        | "isError"
        | "isPending"
        | "isLoading"
        | "isLoadingError"
        | "isRefetchError"
        | "isSuccess"
        | "dataUpdatedAt"
        | "errorUpdatedAt"
        | "failureCount"
        | "failureReason"
        | "errorUpdateCount"
        | "isFetched"
        | "isFetchedAfterMount"
        | "isFetching"
        | "isInitialLoading"
        | "isPlaceholderData"
        | "isRefetching"
        | "isStale"
        | "refetch"
        | "fetchStatus") => void)
    • • (key): void

      • Parameters

        • key:
              | "data"
              | "error"
              | "status"
              | "isPaused"
              | "isError"
              | "isPending"
              | "isLoading"
              | "isLoadingError"
              | "isRefetchError"
              | "isSuccess"
              | "dataUpdatedAt"
              | "errorUpdatedAt"
              | "failureCount"
              | "failureReason"
              | "errorUpdateCount"
              | "isFetched"
              | "isFetchedAfterMount"
              | "isFetching"
              | "isInitialLoading"
              | "isPlaceholderData"
              | "isRefetching"
              | "isStale"
              | "refetch"
              | "fetchStatus"

        Returns void

  Returns QueryObserverResult<TData, TError>

updateResult

• updateResult(notifyOptions?): void

• Parameters

  • OptionalnotifyOptions: NotifyOptions

  Returns void