Interface InfiniteQueryObserverSuccessResult<TData, TError>

interface InfiniteQueryObserverSuccessResult {
    data: InfiniteData<TData>;
    dataUpdatedAt: number;
    error: null;
    errorUpdateCount: number;
    errorUpdatedAt: number;
    failureCount: number;
    failureReason: null | TError;
    fetchNextPage: ((options?) => Promise<InfiniteQueryObserverResult<TData, TError>>);
    fetchPreviousPage: ((options?) => Promise<InfiniteQueryObserverResult<TData, TError>>);
    fetchStatus: FetchStatus;
    hasNextPage?: boolean;
    hasPreviousPage?: boolean;
    isError: false;
    isFetched: boolean;
    isFetchedAfterMount: boolean;
    isFetching: boolean;
    isFetchingNextPage: boolean;
    isFetchingPreviousPage: boolean;
    isInitialLoading: boolean;
    isLoading: false;
    isLoadingError: false;
    isPaused: boolean;
    isPlaceholderData: boolean;
    isPreviousData: boolean;
    isRefetchError: false;
    isRefetching: boolean;
    isStale: boolean;
    isSuccess: true;
    refetch: (<TPageData>(options?) => Promise<QueryObserverResult<InfiniteData<TData>, TError>>);
    remove: (() => void);
    status: "success";
}

Type Parameters

  • TData = unknown

  • TError = unknown

Hierarchy

Properties

data dataUpdatedAt error errorUpdateCount errorUpdatedAt failureCount failureReason fetchNextPage fetchPreviousPage fetchStatus hasNextPage? hasPreviousPage? isError isFetched isFetchedAfterMount isFetching isFetchingNextPage isFetchingPreviousPage isInitialLoading isLoading isLoadingError isPaused isPlaceholderData isPreviousData isRefetchError isRefetching isStale isSuccess refetch remove status

Properties

data

data: InfiniteData<TData>

dataUpdatedAt

dataUpdatedAt: number

error

error: null

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

failureReason

failureReason: null | TError

fetchNextPage

fetchNextPage: ((options?) => Promise<InfiniteQueryObserverResult<TData, TError>>)

Type declaration

fetchPreviousPage

fetchPreviousPage: ((options?) => Promise<InfiniteQueryObserverResult<TData, TError>>)

Type declaration

fetchStatus

fetchStatus: FetchStatus

Optional hasNextPage

hasNextPage?: boolean

Optional hasPreviousPage

hasPreviousPage?: boolean

isError

isError: false

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isFetchingNextPage

isFetchingNextPage: boolean

isFetchingPreviousPage

isFetchingPreviousPage: boolean

isInitialLoading

isInitialLoading: boolean

isLoading

isLoading: false

isLoadingError

isLoadingError: false

isPaused

isPaused: boolean

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: false

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: true

refetch

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

Type declaration

remove

remove: (() => void)

Type declaration

    • (): void

    • Returns void

status

status: "success"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc