Interface UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

interface UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
    _defaulted?: boolean;
    _optimisticResults?: "optimistic" | "isRestoring";
    behavior?: QueryBehavior<TQueryFnData, TError, TQueryData, TQueryKey>;
    enabled?: boolean;
    gcTime?: number;
    initialData?: TQueryData | InitialDataFunction<TQueryData>;
    initialDataUpdatedAt?: number | (() => undefined | number);
    maxPages?: number;
    meta?: Record<string, unknown>;
    networkMode?: NetworkMode;
    notifyOnChangeProps?: NotifyOnChangeProps;
    persister?: ((queryFn, context, query) => NoInfer<TQueryFnData> | Promise<NoInfer<TQueryFnData>>);
    placeholderData?: NonFunctionGuard<TQueryData> | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>;
    queryFn?: QueryFunction<TQueryFnData, TQueryKey, never>;
    queryHash?: string;
    queryKey: TQueryKey & {};
    queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
    refetchInterval?: number | false | ((query) => undefined | number | false);
    refetchIntervalInBackground?: boolean;
    refetchOnMount?: boolean | "always" | ((query) => boolean | "always");
    refetchOnReconnect?: boolean | "always" | ((query) => boolean | "always");
    refetchOnWindowFocus?: boolean | "always" | ((query) => boolean | "always");
    retry?: RetryValue<TError>;
    retryDelay?: RetryDelayValue<TError>;
    retryOnMount?: boolean;
    select?: ((data) => TData);
    staleTime?: number;
    structuralSharing?: boolean | (<T>(oldData, newData) => T);
    suspense?: boolean;
    throwOnError?: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>;
}

Type Parameters

Hierarchy (view full)

Properties

_defaulted? _optimisticResults? behavior? enabled? gcTime? initialData? initialDataUpdatedAt? maxPages? meta? networkMode? notifyOnChangeProps? persister? placeholderData? queryFn? queryHash? queryKey queryKeyHashFn? refetchInterval? refetchIntervalInBackground? refetchOnMount? refetchOnReconnect? refetchOnWindowFocus? retry? retryDelay? retryOnMount? select? staleTime? structuralSharing? suspense? throwOnError?

Properties

Optional _defaulted

_defaulted?: boolean

Optional _optimisticResults

_optimisticResults?: "optimistic" | "isRestoring"

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TQueryData, TQueryKey>

Optional enabled

enabled?: boolean

Set this to false to disable automatic refetching when the query mounts or changes query keys. To refetch the query, use the refetch method returned from the useQuery instance. Defaults to true.

Optional gcTime

gcTime?: number

The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used. Setting it to Infinity will disable garbage collection.

Optional initialData

initialData?: TQueryData | InitialDataFunction<TQueryData>

Optional initialDataUpdatedAt

initialDataUpdatedAt?: number | (() => undefined | number)

Type declaration

    • (): undefined | number

    • Returns undefined | number

Optional maxPages

maxPages?: number

Maximum number of pages to store in the data of an infinite query.

Optional meta

meta?: Record<string, unknown>

Additional payload to be stored on each query. Use this property to pass information that can be used in other places.

Optional networkMode

networkMode?: NetworkMode

Optional notifyOnChangeProps

notifyOnChangeProps?: NotifyOnChangeProps

If set, the component will only re-render if any of the listed properties change. When set to ['data', 'error'], the component will only re-render when the data or error properties change. When set to 'all', the component will re-render whenever a query is updated. When set to a function, the function will be executed to compute the list of properties. By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

Optional persister

persister?: ((queryFn, context, query) => NoInfer<TQueryFnData> | Promise<NoInfer<TQueryFnData>>)

Type declaration

Optional placeholderData

placeholderData?: NonFunctionGuard<TQueryData> | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>

If set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.

Optional queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey, never>

Optional queryHash

queryHash?: string

queryKey

queryKey: TQueryKey & {}

Type declaration

    Optional queryKeyHashFn

    queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

    Optional refetchInterval

    refetchInterval?: number | false | ((query) => undefined | number | false)

    If set to a number, the query will continuously refetch at this frequency in milliseconds. If set to a function, the function will be executed with the latest data and query to compute a frequency Defaults to false.

    Type declaration

    Optional refetchIntervalInBackground

    refetchIntervalInBackground?: boolean

    If set to true, the query will continue to refetch while their tab/window is in the background. Defaults to false.

    Optional refetchOnMount

    refetchOnMount?: boolean | "always" | ((query) => boolean | "always")

    If set to true, the query will refetch on mount if the data is stale. If set to false, will disable additional instances of a query to trigger background refetches. If set to 'always', the query will always refetch on mount. If set to a function, the function will be executed with the latest data and query to compute the value Defaults to true.

    Type declaration

    Optional refetchOnReconnect

    refetchOnReconnect?: boolean | "always" | ((query) => boolean | "always")

    If set to true, the query will refetch on reconnect if the data is stale. If set to false, the query will not refetch on reconnect. If set to 'always', the query will always refetch on reconnect. If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to the value of networkOnline (true)

    Type declaration

    Optional refetchOnWindowFocus

    refetchOnWindowFocus?: boolean | "always" | ((query) => boolean | "always")

    If set to true, the query will refetch on window focus if the data is stale. If set to false, the query will not refetch on window focus. If set to 'always', the query will always refetch on window focus. If set to a function, the function will be executed with the latest data and query to compute the value. Defaults to true.

    Type declaration

    Optional retry

    retry?: RetryValue<TError>

    If false, failed queries will not retry by default. If true, failed queries will retry infinitely., failureCount: num If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number. If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.

    Optional retryDelay

    retryDelay?: RetryDelayValue<TError>

    Optional retryOnMount

    retryOnMount?: boolean

    If set to false, the query will not be retried on mount if it contains an error. Defaults to true.

    Optional select

    select?: ((data) => TData)

    This option can be used to transform or select a part of the data returned by the query function.

    Type declaration

      • (data): TData

      • This option can be used to transform or select a part of the data returned by the query function.

        Parameters

        Returns TData

    Optional staleTime

    staleTime?: number

    The time in milliseconds after data is considered stale. If set to Infinity, the data will never be considered stale.

    Optional structuralSharing

    structuralSharing?: boolean | (<T>(oldData, newData) => T)

    Set this to false to disable structural sharing between query results. Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic. Defaults to true.

    Type declaration

      • <T>(oldData, newData): T

      • Type Parameters

        • T

        Parameters

        • oldData: undefined | T
        • newData: T

        Returns T

    Optional suspense

    suspense?: boolean

    If set to true, the query will suspend when status === 'pending' and throw errors when status === 'error'. Defaults to false.

    Optional throwOnError

    throwOnError?: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>

    Whether errors should be thrown instead of setting the error property. If set to true or suspense is true, all errors will be thrown to the error boundary. If set to false and suspense is false, errors are returned as state. If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false). Defaults to false.

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc