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

Method defaultQueryOptions

packages/query-core/src/queryClient.ts:536–615  ·  view source on GitHub ↗
(
    options:
      | QueryObserverOptions<
          TQueryFnData,
          TError,
          TData,
          TQueryData,
          TQueryKey,
          TPageParam
        >
      | DefaultedQueryObserverOptions<
          TQueryFnData,
          TError,
          TData,
          TQueryData,
          TQueryKey
        >,
  )

Source from the content-addressed store, hash-verified

534 }
535
536 defaultQueryOptions<
537 TQueryFnData = unknown,
538 TError = DefaultError,
539 TData = TQueryFnData,
540 TQueryData = TQueryFnData,
541 TQueryKey extends QueryKey = QueryKey,
542 TPageParam = never,
543 >(
544 options:
545 | QueryObserverOptions<
546 TQueryFnData,
547 TError,
548 TData,
549 TQueryData,
550 TQueryKey,
551 TPageParam
552 >
553 | DefaultedQueryObserverOptions<
554 TQueryFnData,
555 TError,
556 TData,
557 TQueryData,
558 TQueryKey
559 >,
560 ): DefaultedQueryObserverOptions<
561 TQueryFnData,
562 TError,
563 TData,
564 TQueryData,
565 TQueryKey
566 > {
567 if (options._defaulted) {
568 return options as DefaultedQueryObserverOptions<
569 TQueryFnData,
570 TError,
571 TData,
572 TQueryData,
573 TQueryKey
574 >
575 }
576
577 const defaultedOptions = {
578 ...this.#defaultOptions.queries,
579 ...this.getQueryDefaults(options.queryKey),
580 ...options,
581 _defaulted: true,
582 }
583
584 if (!defaultedOptions.queryHash) {
585 defaultedOptions.queryHash = hashQueryKeyByOptions(
586 defaultedOptions.queryKey,
587 defaultedOptions,
588 )
589 }
590
591 // dependent default values
592 if (defaultedOptions.refetchOnReconnect === undefined) {
593 defaultedOptions.refetchOnReconnect =

Callers 15

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

Calls 2

getQueryDefaultsMethod · 0.95
hashQueryKeyByOptionsFunction · 0.90

Tested by

no test coverage detected