Class QueryClient

Constructors

constructor

Methods

cancelQueries clear defaultMutationOptions defaultQueryOptions ensureInfiniteQueryData ensureQueryData fetchInfiniteQuery fetchQuery getDefaultOptions getMutationCache getMutationDefaults getQueriesData getQueryCache getQueryData getQueryDefaults getQueryState invalidateQueries isFetching isMutating mount prefetchInfiniteQuery prefetchQuery refetchQueries removeQueries resetQueries resumePausedMutations setDefaultOptions setMutationDefaults setQueriesData setQueryData setQueryDefaults unmount

Constructors

constructor

  • new QueryClient(config?: QueryClientConfig): QueryClient

    Parameters

    • Optionalconfig: QueryClientConfig

    Returns QueryClient

Methods

cancelQueries

  • cancelQueries<TTaggedQueryKey extends readonly unknown[] = readonly unknown[]>(
        filters?: QueryFilters<TTaggedQueryKey>,
        cancelOptions?: CancelOptions,
    ): Promise<void>

    Type Parameters

    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    • Optionalfilters: QueryFilters<TTaggedQueryKey>
    • OptionalcancelOptions: CancelOptions

    Returns Promise<void>

clear

  • clear(): void

    Returns void

defaultMutationOptions

  • defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(
        options?: T,
    ): T

    Type Parameters

    • T extends MutationOptions<any, any, any, any>

    Parameters

    • Optionaloptions: T

    Returns T

defaultQueryOptions

ensureInfiniteQueryData

ensureQueryData

fetchInfiniteQuery

fetchQuery

getDefaultOptions

  • getDefaultOptions(): DefaultOptions

    Returns DefaultOptions

getMutationCache

  • getMutationCache(): MutationCache

    Returns MutationCache

getMutationDefaults

  • getMutationDefaults(
        mutationKey: readonly unknown[],
    ): OmitKeyof<MutationObserverOptions<any, any, any, any>, "mutationKey">

    Parameters

    • mutationKey: readonly unknown[]

    Returns OmitKeyof<MutationObserverOptions<any, any, any, any>, "mutationKey">

getQueriesData

  • getQueriesData<
        TQueryFnData = unknown,
        TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>,
    >(
        filters: TQueryFilters,
    ): [readonly unknown[], TQueryFnData][]

    Type Parameters

    • TQueryFnData = unknown
    • TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>

    Parameters

    Returns [readonly unknown[], TQueryFnData][]

getQueryCache

  • getQueryCache(): QueryCache

    Returns QueryCache

getQueryData

  • getQueryData<
        TQueryFnData = unknown,
        TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,
    >(
        queryKey: TTaggedQueryKey,
    ): TInferredQueryFnData

    Imperative (non-reactive) way to retrieve data for a QueryKey. Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.

    Hint: Do not use this function inside a component, because it won't receive updates. Use useQuery to create a QueryObserver that subscribes to changes.

    Type Parameters

    • TQueryFnData = unknown
    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
    • TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>

    Parameters

    Returns TInferredQueryFnData

getQueryDefaults

  • getQueryDefaults(
        queryKey: readonly unknown[],
    ): OmitKeyof<
        QueryObserverOptions<any, any, any, any, any, never>,
        "queryKey",
    >

    Parameters

    • queryKey: readonly unknown[]

    Returns OmitKeyof<QueryObserverOptions<any, any, any, any, any, never>, "queryKey">

getQueryState

invalidateQueries

  • invalidateQueries<
        TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
    >(
        filters?: InvalidateQueryFilters<TTaggedQueryKey>,
        options?: InvalidateOptions,
    ): Promise<void>

    Type Parameters

    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    • Optionalfilters: InvalidateQueryFilters<TTaggedQueryKey>
    • Optionaloptions: InvalidateOptions

    Returns Promise<void>

isFetching

  • isFetching<
        TQueryFilters extends
            QueryFilters<any> = QueryFilters<readonly unknown[]>,
    >(
        filters?: TQueryFilters,
    ): number

    Type Parameters

    • TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>

    Parameters

    Returns number

isMutating

  • isMutating<
        TMutationFilters extends
            MutationFilters<any, any, unknown, unknown> = MutationFilters<
            unknown,
            Error,
            unknown,
            unknown,
        >,
    >(
        filters?: TMutationFilters,
    ): number

    Type Parameters

    • TMutationFilters extends MutationFilters<any, any, unknown, unknown> = MutationFilters<unknown, Error, unknown, unknown>

    Parameters

    Returns number

mount

  • mount(): void

    Returns void

prefetchInfiniteQuery

  • prefetchInfiniteQuery<
        TQueryFnData,
        TError = Error,
        TData = TQueryFnData,
        TQueryKey extends readonly unknown[] = readonly unknown[],
        TPageParam = unknown,
    >(
        options: FetchInfiniteQueryOptions<
            TQueryFnData,
            TError,
            TData,
            TQueryKey,
            TPageParam,
        >,
    ): Promise<void>

    Type Parameters

    • TQueryFnData
    • TError = Error
    • TData = TQueryFnData
    • TQueryKey extends readonly unknown[] = readonly unknown[]
    • TPageParam = unknown

    Parameters

    Returns Promise<void>

prefetchQuery

  • prefetchQuery<
        TQueryFnData = unknown,
        TError = Error,
        TData = TQueryFnData,
        TQueryKey extends readonly unknown[] = readonly unknown[],
    >(
        options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
    ): Promise<void>

    Type Parameters

    • TQueryFnData = unknown
    • TError = Error
    • TData = TQueryFnData
    • TQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    Returns Promise<void>

refetchQueries

  • refetchQueries<TTaggedQueryKey extends readonly unknown[] = readonly unknown[]>(
        filters?: RefetchQueryFilters<TTaggedQueryKey>,
        options?: RefetchOptions,
    ): Promise<void>

    Type Parameters

    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    • Optionalfilters: RefetchQueryFilters<TTaggedQueryKey>
    • Optionaloptions: RefetchOptions

    Returns Promise<void>

removeQueries

  • removeQueries<TTaggedQueryKey extends readonly unknown[] = readonly unknown[]>(
        filters?: QueryFilters<TTaggedQueryKey>,
    ): void

    Type Parameters

    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    Returns void

resetQueries

  • resetQueries<TTaggedQueryKey extends readonly unknown[] = readonly unknown[]>(
        filters?: QueryFilters<TTaggedQueryKey>,
        options?: ResetOptions,
    ): Promise<void>

    Type Parameters

    • TTaggedQueryKey extends readonly unknown[] = readonly unknown[]

    Parameters

    • Optionalfilters: QueryFilters<TTaggedQueryKey>
    • Optionaloptions: ResetOptions

    Returns Promise<void>

resumePausedMutations

  • resumePausedMutations(): Promise<unknown>

    Returns Promise<unknown>

setDefaultOptions

  • setDefaultOptions(options: DefaultOptions): void

    Parameters

    • options: DefaultOptions

    Returns void

setMutationDefaults

  • setMutationDefaults<
        TData = unknown,
        TError = Error,
        TVariables = void,
        TOnMutateResult = unknown,
    >(
        mutationKey: readonly unknown[],
        options: OmitKeyof<
            MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>,
            "mutationKey",
        >,
    ): void

    Type Parameters

    • TData = unknown
    • TError = Error
    • TVariables = void
    • TOnMutateResult = unknown

    Parameters

    Returns void

setQueriesData

  • setQueriesData<
        TQueryFnData,
        TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>,
    >(
        filters: TQueryFilters,
        updater: Updater<NoInfer<TQueryFnData>, NoInfer<TQueryFnData>>,
        options?: SetDataOptions,
    ): [readonly unknown[], TQueryFnData][]

    Type Parameters

    • TQueryFnData
    • TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>

    Parameters

    Returns [readonly unknown[], TQueryFnData][]

setQueryData

setQueryDefaults

  • setQueryDefaults<
        TQueryFnData = unknown,
        TError = Error,
        TData = TQueryFnData,
        TQueryData = TQueryFnData,
    >(
        queryKey: readonly unknown[],
        options: Partial<
            OmitKeyof<
                QueryObserverOptions<
                    TQueryFnData,
                    TError,
                    TData,
                    TQueryData,
                    readonly unknown[],
                    never,
                >,
                "queryKey",
                "strictly",
            >,
        >,
    ): void

    Type Parameters

    Parameters

    • queryKey: readonly unknown[]
    • options: Partial<
          OmitKeyof<
              QueryObserverOptions<
                  TQueryFnData,
                  TError,
                  TData,
                  TQueryData,
                  readonly unknown[],
                  never,
              >,
              "queryKey",
              "strictly",
          >,
      >

    Returns void

unmount

  • unmount(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods