Interface UseSpotPriceReturn<TTokens>

The return type of the useSpotPrice hook. spotPrices - An object mapping each token symbol to its spot price.

interface UseSpotPriceReturn {
    dataUpdatedAt: number;
    error: null | ConnectError;
    errorUpdateCount: number;
    errorUpdatedAt: number;
    failureCount: number;
    failureReason: null | ConnectError;
    fetchStatus: FetchStatus;
    isError: boolean;
    isFetched: boolean;
    isFetchedAfterMount: boolean;
    isFetching: boolean;
    isInitialLoading: boolean;
    isLoading: boolean;
    isLoadingError: boolean;
    isPaused: boolean;
    isPlaceholderData: boolean;
    isPreviousData: boolean;
    isRefetchError: boolean;
    isRefetching: boolean;
    isStale: boolean;
    isSuccess: boolean;
    refetch: (<TPageData>(options?) => Promise<QueryObserverResult<Record<string, Price>, ConnectError>>);
    remove: (() => void);
    spotPrices?: Record<InferSymbols<TTokens>, Price>;
    status: "error" | "success" | "loading";
}

Type Parameters

Hierarchy

Properties

dataUpdatedAt error errorUpdateCount errorUpdatedAt failureCount failureReason fetchStatus isError isFetched isFetchedAfterMount isFetching isInitialLoading isLoading isLoadingError isPaused isPlaceholderData isPreviousData isRefetchError isRefetching isStale isSuccess refetch remove spotPrices? status

Properties

dataUpdatedAt

dataUpdatedAt: number

error

error: null | ConnectError

errorUpdateCount

errorUpdateCount: number

errorUpdatedAt

errorUpdatedAt: number

failureCount

failureCount: number

failureReason

failureReason: null | ConnectError

fetchStatus

fetchStatus: FetchStatus

isError

isError: boolean

isFetched

isFetched: boolean

isFetchedAfterMount

isFetchedAfterMount: boolean

isFetching

isFetching: boolean

isInitialLoading

isInitialLoading: boolean

isLoading

isLoading: boolean

isLoadingError

isLoadingError: boolean

isPaused

isPaused: boolean

isPlaceholderData

isPlaceholderData: boolean

isPreviousData

isPreviousData: boolean

isRefetchError

isRefetchError: boolean

isRefetching

isRefetching: boolean

isStale

isStale: boolean

isSuccess

isSuccess: boolean

refetch

refetch: (<TPageData>(options?) => Promise<QueryObserverResult<Record<string, Price>, ConnectError>>)

Type declaration

remove

remove: (() => void)

Type declaration

    • (): void

    • Returns void

Optional spotPrices

spotPrices?: Record<InferSymbols<TTokens>, Price>

status

status: "error" | "success" | "loading"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc