Circle V2 API Docs
    Preparing search index...

    Interface QueryClient

    interface QueryClient {
        cancelQueries<
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            filters?: QueryFilters<TTaggedQueryKey>,
            cancelOptions?: CancelOptions,
        ): Promise<void>;
        clear(): void;
        defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(
            options?: T,
        ): T;
        defaultQueryOptions<
            TQueryFnData = unknown,
            TError = Error,
            TData = TQueryFnData,
            TQueryData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
            TPageParam = never,
        >(
            options:
                | QueryObserverOptions<
                    TQueryFnData,
                    TError,
                    TData,
                    TQueryData,
                    TQueryKey,
                    TPageParam,
                >
                | DefaultedQueryObserverOptions<
                    TQueryFnData,
                    TError,
                    TData,
                    TQueryData,
                    TQueryKey,
                >,
        ): DefaultedQueryObserverOptions<
            TQueryFnData,
            TError,
            TData,
            TQueryData,
            TQueryKey,
        >;
        ensureInfiniteQueryData<
            TQueryFnData,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
            TPageParam = unknown,
        >(
            options: EnsureInfiniteQueryDataOptions<
                TQueryFnData,
                TError,
                TData,
                TQueryKey,
                TPageParam,
            >,
        ): Promise<InfiniteData<TData, TPageParam>>;
        ensureQueryData<
            TQueryFnData,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>,
        ): Promise<TData>;
        fetchInfiniteQuery<
            TQueryFnData,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
            TPageParam = unknown,
        >(
            options: FetchInfiniteQueryOptions<
                TQueryFnData,
                TError,
                TData,
                TQueryKey,
                TPageParam,
            >,
        ): Promise<InfiniteData<TData, TPageParam>>;
        fetchQuery<
            TQueryFnData,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
            TPageParam = never,
        >(
            options: FetchQueryOptions<
                TQueryFnData,
                TError,
                TData,
                TQueryKey,
                TPageParam,
            >,
        ): Promise<TData>;
        getDefaultOptions(): DefaultOptions;
        getMutationCache(): MutationCache;
        getMutationDefaults(
            mutationKey: readonly unknown[],
        ): OmitKeyof<MutationObserverOptions<any, any, any, any>, "mutationKey">;
        getQueriesData<
            TQueryFnData = unknown,
            TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>,
        >(
            filters: TQueryFilters,
        ): [readonly unknown[], TQueryFnData | undefined][];
        getQueryCache(): QueryCache;
        getQueryData<
            TQueryFnData = unknown,
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
            TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,
        >(
            queryKey: TTaggedQueryKey,
        ): TInferredQueryFnData | undefined;
        getQueryDefaults(
            queryKey: readonly unknown[],
        ): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">;
        getQueryState<
            TQueryFnData = unknown,
            TError = Error,
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
            TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,
            TInferredError = InferErrorFromTag<TError, TTaggedQueryKey>,
        >(
            queryKey: TTaggedQueryKey,
        ): QueryState<TInferredQueryFnData, TInferredError> | undefined;
        invalidateQueries<
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            filters?: InvalidateQueryFilters<TTaggedQueryKey>,
            options?: InvalidateOptions,
        ): Promise<void>;
        isFetching<
            TQueryFilters extends
                QueryFilters<any> = QueryFilters<readonly unknown[]>,
        >(
            filters?: TQueryFilters,
        ): number;
        isMutating<
            TMutationFilters extends
                MutationFilters<any, any, unknown, unknown> = MutationFilters<
                unknown,
                Error,
                unknown,
                unknown,
            >,
        >(
            filters?: TMutationFilters,
        ): number;
        mount(): void;
        prefetchInfiniteQuery<
            TQueryFnData,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
            TPageParam = unknown,
        >(
            options: FetchInfiniteQueryOptions<
                TQueryFnData,
                TError,
                TData,
                TQueryKey,
                TPageParam,
            >,
        ): Promise<void>;
        prefetchQuery<
            TQueryFnData = unknown,
            TError = Error,
            TData = TQueryFnData,
            TQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
        ): Promise<void>;
        refetchQueries<
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            filters?: RefetchQueryFilters<TTaggedQueryKey>,
            options?: RefetchOptions,
        ): Promise<void>;
        removeQueries<
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            filters?: QueryFilters<TTaggedQueryKey>,
        ): void;
        resetQueries<
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
        >(
            filters?: QueryFilters<TTaggedQueryKey>,
            options?: ResetOptions,
        ): Promise<void>;
        resumePausedMutations(): Promise<unknown>;
        setDefaultOptions(options: DefaultOptions): void;
        setMutationDefaults<
            TData = unknown,
            TError = Error,
            TVariables = void,
            TOnMutateResult = unknown,
        >(
            mutationKey: readonly unknown[],
            options: OmitKeyof<
                MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>,
                "mutationKey",
            >,
        ): void;
        setQueriesData<
            TQueryFnData,
            TQueryFilters extends QueryFilters<any> = QueryFilters<readonly unknown[]>,
        >(
            filters: TQueryFilters,
            updater: Updater<
                NoInfer<TQueryFnData>
                | undefined,
                NoInfer<TQueryFnData> | undefined,
            >,
            options?: SetDataOptions,
        ): [readonly unknown[], TQueryFnData | undefined][];
        setQueryData<
            TQueryFnData = unknown,
            TTaggedQueryKey extends readonly unknown[] = readonly unknown[],
            TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>,
        >(
            queryKey: TTaggedQueryKey,
            updater: Updater<
                NoInfer<TInferredQueryFnData>
                | undefined,
                NoInfer<TInferredQueryFnData> | undefined,
            >,
            options?: SetDataOptions,
        ): NoInfer<TInferredQueryFnData> | undefined;
        setQueryDefaults<
            TQueryFnData = unknown,
            TError = Error,
            TData = TQueryFnData,
            TQueryData = TQueryFnData,
        >(
            queryKey: readonly unknown[],
            options: Partial<
                OmitKeyof<
                    QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>,
                    "queryKey",
                >,
            >,
        ): void;
        unmount(): void;
    }
    Index

    Methods

    • Type Parameters

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

      Parameters

      • Optionalfilters: QueryFilters<TTaggedQueryKey>
      • OptionalcancelOptions: CancelOptions

      Returns Promise<void>

    • Returns void

    • Type Parameters

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

      Parameters

      • Optionaloptions: T

      Returns T

    • Returns DefaultOptions

    • Returns MutationCache

    • Parameters

      • mutationKey: readonly unknown[]

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

    • Type Parameters

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

      Parameters

      Returns [readonly unknown[], TQueryFnData | undefined][]

    • Returns QueryCache

    • 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 | undefined

    • Parameters

      • queryKey: readonly unknown[]

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

    • Type Parameters

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

      Parameters

      • Optionalfilters: InvalidateQueryFilters<TTaggedQueryKey>
      • Optionaloptions: InvalidateOptions

      Returns Promise<void>

    • Type Parameters

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

      Parameters

      Returns number

    • Type Parameters

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

      Parameters

      Returns number

    • Returns void

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    • Type Parameters

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

      Parameters

      Returns Promise<void>

    • Type Parameters

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

      Parameters

      • Optionalfilters: RefetchQueryFilters<TTaggedQueryKey>
      • Optionaloptions: RefetchOptions

      Returns Promise<void>

    • Type Parameters

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

      Parameters

      Returns void

    • Type Parameters

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

      Parameters

      • Optionalfilters: QueryFilters<TTaggedQueryKey>
      • Optionaloptions: ResetOptions

      Returns Promise<void>

    • Returns Promise<unknown>

    • Parameters

      • options: DefaultOptions

      Returns void

    • Type Parameters

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

      Parameters

      Returns void

    • Type Parameters

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

      Parameters

      Returns [readonly unknown[], TQueryFnData | undefined][]

    • Type Parameters

      Parameters

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

      Returns void

    • Returns void