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

Method defaultQueryOptions

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

622 }
623
624 defaultQueryOptions<
625 TQueryFnData = unknown,
626 TError = DefaultError,
627 TData = TQueryFnData,
628 TQueryData = TQueryFnData,
629 TQueryKey extends QueryKey = QueryKey,
630 TPageParam = never,
631 >(
632 options:
633 | QueryObserverOptions<
634 TQueryFnData,
635 TError,
636 TData,
637 TQueryData,
638 TQueryKey,
639 TPageParam
640 >
641 | DefaultedQueryObserverOptions<
642 TQueryFnData,
643 TError,
644 TData,
645 TQueryData,
646 TQueryKey
647 >,
648 ): DefaultedQueryObserverOptions<
649 TQueryFnData,
650 TError,
651 TData,
652 TQueryData,
653 TQueryKey
654 > {
655 if (options._defaulted) {
656 return options as DefaultedQueryObserverOptions<
657 TQueryFnData,
658 TError,
659 TData,
660 TQueryData,
661 TQueryKey
662 >
663 }
664
665 const defaultedOptions = {
666 ...this.#defaultOptions.queries,
667 ...this.getQueryDefaults(options.queryKey),
668 ...options,
669 _defaulted: true,
670 }
671
672 if (!defaultedOptions.queryHash) {
673 defaultedOptions.queryHash = hashQueryKeyByOptions(
674 defaultedOptions.queryKey,
675 defaultedOptions,
676 )
677 }
678
679 // dependent default values
680 if (defaultedOptions.refetchOnReconnect === undefined) {
681 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