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

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Constructors

constructor

Properties

clearRefetchInterval clearStaleTimeout client computeRefetchInterval currentQuery currentQueryInitialState currentRefetchInterval? currentResult currentResultOptions? currentResultState? executeFetch listeners notify options previousQueryResult? refetchIntervalId? selectError selectFn? selectResult? staleTimeoutId? trackedProps updateQuery updateRefetchInterval updateStaleTimeout updateTimers

Methods

bindMethods createResult destroy fetch fetchOptimistic getCurrentQuery getCurrentResult getOptimisticResult hasListeners onQueryUpdate onSubscribe onUnsubscribe refetch remove setOptions shouldFetchOnReconnect shouldFetchOnWindowFocus subscribe trackResult updateResult

Constructors

constructor

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

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

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

Properties

Private clearRefetchInterval

clearRefetchInterval: any

Private clearStaleTimeout

clearStaleTimeout: any

Private client

client: any

Private computeRefetchInterval

computeRefetchInterval: any

Private currentQuery

currentQuery: any

Private currentQueryInitialState

currentQueryInitialState: any

Private Optional currentRefetchInterval

currentRefetchInterval?: any

Private currentResult

currentResult: any

Private Optional currentResultOptions

currentResultOptions?: any

Private Optional currentResultState

currentResultState?: any

Private executeFetch

executeFetch: any

Protected listeners

listeners: Set<{
    listener: QueryObserverListener<TData, TError>;
}>

Type declaration

Private notify

notify: any

options

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

Private Optional previousQueryResult

previousQueryResult?: any

Private Optional refetchIntervalId

refetchIntervalId?: any

Private selectError

selectError: any

Private Optional selectFn

selectFn?: any

Private Optional selectResult

selectResult?: any

Private Optional staleTimeoutId

staleTimeoutId?: any

Private trackedProps

trackedProps: any

Private updateQuery

updateQuery: any

Private updateRefetchInterval

updateRefetchInterval: any

Private updateStaleTimeout

updateStaleTimeout: any

Private updateTimers

updateTimers: any

Methods

Protected bindMethods

  • bindMethods(): void

  • Returns void

Protected createResult

  • createResult(query, options): QueryObserverResult<TData, TError>

  • Parameters

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

    Returns QueryObserverResult<TData, TError>

destroy

  • destroy(): void

  • Returns void

Protected fetch

fetchOptimistic

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

  • Parameters

    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

hasListeners

  • hasListeners(): boolean

  • Returns boolean

onQueryUpdate

  • onQueryUpdate(action): void

  • Parameters

    Returns void

Protected onSubscribe

  • onSubscribe(): void

  • Returns void

Protected onUnsubscribe

  • onUnsubscribe(): void

  • Returns void

refetch

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

  • Type Parameters

    • TPageData

    Parameters

    Returns Promise<QueryObserverResult<TData, TError>>

remove

  • remove(): void

  • Returns void

setOptions

  • setOptions(options?, notifyOptions?): void

  • Parameters

    Returns void

shouldFetchOnReconnect

  • shouldFetchOnReconnect(): boolean

  • Returns boolean

shouldFetchOnWindowFocus

  • shouldFetchOnWindowFocus(): boolean

  • Returns boolean

subscribe

  • subscribe(listener): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

trackResult

updateResult

  • updateResult(notifyOptions?): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc