Interface QueryOptions<TQueryFnData, TError, TData, TQueryKey>

interface QueryOptions {
    _defaulted?: boolean;
    behavior?: QueryBehavior<TQueryFnData, TError, TData, QueryKey>;
    cacheTime?: number;
    getNextPageParam?: GetNextPageParamFunction<TQueryFnData>;
    getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>;
    initialData?: TData | InitialDataFunction<TData>;
    initialDataUpdatedAt?: number | (() => undefined | number);
    isDataEqual?: ((oldData, newData) => boolean);
    meta?: QueryMeta;
    networkMode?: NetworkMode;
    queryFn?: QueryFunction<TQueryFnData, TQueryKey, any>;
    queryHash?: string;
    queryKey?: TQueryKey;
    queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>;
    retry?: RetryValue<TError>;
    retryDelay?: RetryDelayValue<TError>;
    structuralSharing?: boolean | ((oldData, newData) => TData);
}

Type Parameters

  • TQueryFnData = unknown

  • TError = unknown

  • TData = TQueryFnData

  • TQueryKey extends QueryKey = QueryKey

Hierarchy

Properties

_defaulted? behavior? cacheTime? getNextPageParam? getPreviousPageParam? initialData? initialDataUpdatedAt? isDataEqual? meta? networkMode? queryFn? queryHash? queryKey? queryKeyHashFn? retry? retryDelay? structuralSharing?

Properties

Optional _defaulted

_defaulted?: boolean

Optional behavior

behavior?: QueryBehavior<TQueryFnData, TError, TData, QueryKey>

Optional cacheTime

cacheTime?: number

Optional getNextPageParam

getNextPageParam?: GetNextPageParamFunction<TQueryFnData>

This function can be set to automatically get the next cursor for infinite queries. The result will also be used to determine the value of hasNextPage.

Optional getPreviousPageParam

getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>

This function can be set to automatically get the previous cursor for infinite queries. The result will also be used to determine the value of hasPreviousPage.

Optional initialData

initialData?: TData | InitialDataFunction<TData>

Optional initialDataUpdatedAt

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

Type declaration

    • (): undefined | number

    • Returns undefined | number

Optional isDataEqual

isDataEqual?: ((oldData, newData) => boolean)

Type declaration

    • (oldData, newData): boolean

    • Parameters

      • oldData: undefined | TData
      • newData: TData

      Returns boolean

      Deprecated

      This callback will be removed in the next major version. You can achieve the same functionality by passing a function to structuralSharing instead.

Optional meta

meta?: QueryMeta

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 queryFn

queryFn?: QueryFunction<TQueryFnData, TQueryKey, any>

Optional queryHash

queryHash?: string

Optional queryKey

queryKey?: TQueryKey

Optional queryKeyHashFn

queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>

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 structuralSharing

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

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

    • (oldData, newData): TData

    • Parameters

      • oldData: undefined | TData
      • newData: TData

      Returns TData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc