Interface UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>

interface UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey> {
    _defaulted?: boolean;
    _optimisticResults?: "optimistic" | "isRestoring";
    behavior?: QueryBehavior<TQueryFnData, TError, TQueryFnData, TQueryKey>;
    gcTime?: number;
    initialData?: TQueryFnData | InitialDataFunction<TQueryFnData>;
    initialDataUpdatedAt?: number | (() => undefined | number);
    maxPages?: number;
    meta?: Record<string, unknown>;
    networkMode?: NetworkMode;
    notifyOnChangeProps?: NotifyOnChangeProps;
    persister?: ((queryFn: QueryFunction<NoInfer<TQueryFnData>, NoInfer<TQueryKey>, never>, context: {
        direction?: unknown;
        meta: undefined | Record<string, unknown>;
        pageParam?: unknown;
        queryKey: NoInfer<TQueryKey>;
        signal: AbortSignal;
    }, query: Query<unknown, Error, unknown, QueryKey>) => NoInfer<TQueryFnData> | Promise<NoInfer<TQueryFnData>>);
    queryFn?: typeof skipToken | QueryFunction<TQueryFnData, TQueryKey, never>;
    queryHash?: string;
    queryKey: TQueryKey & {};
    queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
    refetchInterval?: number | false | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => undefined | number | false);
    refetchIntervalInBackground?: boolean;
    refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always");
    refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always");
    refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => boolean | "always");
    retry?: RetryValue<TError>;
    retryDelay?: RetryDelayValue<TError>;
    retryOnMount?: boolean;
    select?: ((data: TQueryFnData) => TData);
    staleTime?: StaleTime<TQueryFnData, TError, TQueryFnData, TQueryKey>;
    structuralSharing?: boolean | ((oldData: unknown, newData: unknown) => unknown);
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional_defaulted

_defaulted?: boolean

Optional_optimisticResults

_optimisticResults?: "optimistic" | "isRestoring"

Optionalbehavior

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

OptionalgcTime

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.

OptionalinitialData

initialData?: TQueryFnData | InitialDataFunction<TQueryFnData>

OptionalinitialDataUpdatedAt

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

OptionalmaxPages

maxPages?: number

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

Optionalmeta

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.

OptionalnetworkMode

networkMode?: NetworkMode

OptionalnotifyOnChangeProps

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.

Optionalpersister

persister?: ((queryFn: QueryFunction<NoInfer<TQueryFnData>, NoInfer<TQueryKey>, never>, context: {
    direction?: unknown;
    meta: undefined | Record<string, unknown>;
    pageParam?: unknown;
    queryKey: NoInfer<TQueryKey>;
    signal: AbortSignal;
}, query: Query<unknown, Error, unknown, QueryKey>) => NoInfer<TQueryFnData> | Promise<NoInfer<TQueryFnData>>)

OptionalqueryFn

queryFn?: typeof skipToken | QueryFunction<TQueryFnData, TQueryKey, never>

OptionalqueryHash

queryHash?: string

queryKey

queryKey: TQueryKey & {}

OptionalqueryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

OptionalrefetchInterval

refetchInterval?: number | false | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => 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.

OptionalrefetchIntervalInBackground

refetchIntervalInBackground?: boolean

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

OptionalrefetchOnMount

refetchOnMount?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => 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 refetch. 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.

OptionalrefetchOnReconnect

refetchOnReconnect?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => 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)

OptionalrefetchOnWindowFocus

refetchOnWindowFocus?: boolean | "always" | ((query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) => 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.

Optionalretry

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.

OptionalretryDelay

retryDelay?: RetryDelayValue<TError>

OptionalretryOnMount

retryOnMount?: boolean

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

Optionalselect

select?: ((data: TQueryFnData) => TData)

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

OptionalstaleTime

staleTime?: StaleTime<TQueryFnData, TError, TQueryFnData, TQueryKey>

The time in milliseconds after data is considered stale. If set to Infinity, the data will never be considered stale. If set to a function, the function will be executed with the query to compute a staleTime.

OptionalstructuralSharing

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

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.

Settings

Member Visibility

On This Page

Properties