Interface QueryObserverBaseResult<TData, TError>

interface QueryObserverBaseResult<TData, TError> {
    data: undefined | TData;
    dataUpdatedAt: number;
    error: null | TError;
    errorUpdateCount: number;
    errorUpdatedAt: number;
    failureCount: number;
    failureReason: null | TError;
    fetchStatus: FetchStatus;
    isError: boolean;
    isFetched: boolean;
    isFetchedAfterMount: boolean;
    isFetching: boolean;
    isInitialLoading: boolean;
    isLoading: boolean;
    isLoadingError: boolean;
    isPaused: boolean;
    isPending: boolean;
    isPlaceholderData: boolean;
    isRefetchError: boolean;
    isRefetching: boolean;
    isStale: boolean;
    isSuccess: boolean;
    refetch: ((options?) => Promise<QueryObserverResult<TData, TError>>);
    status: QueryStatus;
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

data

data: undefined | TData

dataUpdatedAt

dataUpdatedAt: number

error

error: null | TError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

failureReason

failureReason: null | TError

fetchStatus

fetchStatus: FetchStatus

isError

isError: boolean

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isInitialLoading

isInitialLoading: boolean

Deprecated

isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version.

isLoading

isLoading: boolean

isLoadingError

isLoadingError: boolean

isPaused

isPaused: boolean

isPending

isPending: boolean

isPlaceholderData

isPlaceholderData: boolean

isRefetchError

isRefetchError: boolean

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: boolean

refetch

refetch: ((options?) => Promise<QueryObserverResult<TData, TError>>)

Type declaration

status

status: QueryStatus

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc