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

Method defaultQueryOptions

packages/query-core/src/queryClient.ts:1059–1138  ·  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

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