MCPcopy Create free account
hub / github.com/TanStack/query / defaultQueryOptions

Method defaultQueryOptions

packages/query-core/src/queryClient.ts:1058–1137  ·  view source on GitHub ↗

* Called by framework adapters (e.g. inside `useQuery`) to resolve the options passed by the * caller into their final, defaulted form: merging the client's own `defaultOptions.queries`, * then `queryClient.setQueryDefaults` for the given `queryKey`, then the caller's options on * top. A no

(
    options:
      | QueryObserverOptions<
          TQueryFnData,
          TError,
          TData,
          TQueryData,
          TQueryKey,
          TPageParam
        >
      | DefaultedQueryObserverOptions<
          TQueryFnData,
          TError,
          TData,
          TQueryData,
          TQueryKey
        >,
  )

Source from the content-addressed store, hash-verified

1056 * `refetchOnReconnect`) filled in.
1057 */
1058 defaultQueryOptions<
1059 TQueryFnData = unknown,
1060 TError = DefaultError,
1061 TData = TQueryFnData,
1062 TQueryData = TQueryFnData,
1063 TQueryKey extends QueryKey = QueryKey,
1064 TPageParam = never,
1065 >(
1066 options:
1067 | QueryObserverOptions<
1068 TQueryFnData,
1069 TError,
1070 TData,
1071 TQueryData,
1072 TQueryKey,
1073 TPageParam
1074 >
1075 | DefaultedQueryObserverOptions<
1076 TQueryFnData,
1077 TError,
1078 TData,
1079 TQueryData,
1080 TQueryKey
1081 >,
1082 ): DefaultedQueryObserverOptions<
1083 TQueryFnData,
1084 TError,
1085 TData,
1086 TQueryData,
1087 TQueryKey
1088 > {
1089 if (options._defaulted) {
1090 return options as DefaultedQueryObserverOptions<
1091 TQueryFnData,
1092 TError,
1093 TData,
1094 TQueryData,
1095 TQueryKey
1096 >
1097 }
1098
1099 const defaultedOptions = {
1100 ...this.#defaultOptions.queries,
1101 ...this.getQueryDefaults(options.queryKey),
1102 ...options,
1103 _defaulted: true,
1104 }
1105
1106 if (!defaultedOptions.queryHash) {
1107 defaultedOptions.queryHash = hashQueryKeyByOptions(
1108 defaultedOptions.queryKey,
1109 defaultedOptions,
1110 )
1111 }
1112
1113 // dependent default values
1114 if (defaultedOptions.refetchOnReconnect === undefined) {
1115 defaultedOptions.refetchOnReconnect =

Callers 15

getQueryDataMethod · 0.95
ensureQueryDataMethod · 0.95
setQueryDataMethod · 0.95
getQueryStateMethod · 0.95
queryMethod · 0.95
fetchQueryMethod · 0.95
defaultOptionsMethod · 0.80
resolveQueriesOptionsFunction · 0.80
defaultOptionsMethod · 0.80
useBaseQueryFunction · 0.80
useQueriesFunction · 0.80
useBaseQueryFunction · 0.80

Calls 2

getQueryDefaultsMethod · 0.95
hashQueryKeyByOptionsFunction · 0.90

Tested by

no test coverage detected