Class Query<TQueryFnData, TError, TData, TQueryKey>

constructor

• new Query<TQueryFnData, TError, TData, TQueryKey>(config): Query<TQueryFnData, TError, TData, TQueryKey>

• Type Parameters

  • TQueryFnData = unknown

  • TError = Error

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

  Parameters

  • config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>

  Returns Query<TQueryFnData, TError, TData, TQueryKey>

Optional isFetchingOptimistic

options

queryHash

queryKey

state

meta

• get meta(): undefined | Record<string, unknown>

• Returns undefined | Record<string, unknown>

addObserver

• addObserver(observer): void

• Parameters

  • observer: QueryObserver<any, any, any, any, any>

  Returns void

cancel

• cancel(options?): Promise<void>

• Parameters

  • Optional options: CancelOptions

  Returns Promise<void>

destroy

• destroy(): void

• Returns void

fetch

• fetch(options?, fetchOptions?): Promise<TData>

• Parameters

  • Optional options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, never>

  • Optional fetchOptions: FetchOptions

  Returns Promise<TData>

getObserversCount

• getObserversCount(): number

• Returns number

invalidate

• invalidate(): void

• Returns void

isActive

• isActive(): boolean

• Returns boolean

isDisabled

• isDisabled(): boolean

• Returns boolean

isStale

• isStale(): boolean

• Returns boolean

isStaleByTime

• isStaleByTime(staleTime?): boolean

• Parameters

  • Optional staleTime: number

  Returns boolean

onFocus

• onFocus(): void

• Returns void

onOnline

• onOnline(): void

• Returns void

removeObserver

• removeObserver(observer): void

• Parameters

  • observer: QueryObserver<any, any, any, any, any>

  Returns void

reset

• reset(): void

• Returns void

setData

• setData(newData, options?): TData

• Parameters

  • newData: TData

  • Optional options: SetDataOptions & {
        manual: boolean;
    }

  Returns TData

setState

• setState(state, setStateOptions?): void

• Parameters

  • state: Partial<QueryState<TData, TError>>

  • Optional setStateOptions: SetStateOptions

  Returns void