@trpc/react-query 11.23.0 → 11.23.1-canary.14.507382d73

package/src/createTRPCReact.tsx

@@ -297,7 +297,7 @@ export type MaybeDecoratedInfiniteQuery<TDef extends ResolverDef> =
   TDef['input'] extends CursorInput
     ? {
         /**
-         * @see https://trpc.io/docs/v11/client/react/useInfiniteQuery
+         * @see https://trpc.io/docs/client/react/useInfiniteQuery
          */
         useInfiniteQuery: useTRPCInfiniteQuery<TDef>;
         /**
@@ -321,12 +321,12 @@ export type MaybeDecoratedInfiniteQuery<TDef extends ResolverDef> =
  */
 export type DecoratedQueryMethods<TDef extends ResolverDef> = {
   /**
-   * @see https://trpc.io/docs/v11/client/react/useQuery
+   * @see https://trpc.io/docs/client/react/useQuery
    */
   useQuery: ProcedureUseQuery<TDef>;
   usePrefetchQuery: ProcedureUsePrefetchQuery<TDef>;
   /**
-   * @see https://trpc.io/docs/v11/client/react/suspense#usesuspensequery
+   * @see https://trpc.io/docs/client/react/suspense#usesuspensequery
    */
   useSuspenseQuery: <
     TQueryFnData extends TDef['output'] = TDef['output'],
@@ -352,7 +352,7 @@ export type DecoratedQuery<TDef extends ResolverDef> =
 
 export type DecoratedMutation<TDef extends ResolverDef> = {
   /**
-   * @see https://trpc.io/docs/v11/client/react/useMutation
+   * @see https://trpc.io/docs/client/react/useMutation
    */
   useMutation: <TContext = unknown>(
     opts?: UseTRPCMutationOptions<
@@ -410,7 +410,7 @@ export type DecorateProcedure<
     : TType extends 'subscription'
       ? {
           /**
-           * @see https://trpc.io/docs/v11/subscriptions
+           * @see https://trpc.io/docs/client/react/useSubscription
            */
           useSubscription: ProcedureUseSubscription<TDef>;
         }
@@ -447,19 +447,39 @@ export type CreateTRPCReactBase<TRouter extends AnyRouter, TSSRContext> = {
   /**
    * @deprecated renamed to `useUtils` and will be removed in a future tRPC version
    *
-   * @see https://trpc.io/docs/v11/client/react/useUtils
+   * @see https://trpc.io/docs/client/react/useUtils
    */
   useContext(): CreateReactUtils<TRouter, TSSRContext>;
   /**
-   * @see https://trpc.io/docs/v11/client/react/useUtils
+   * @see https://trpc.io/docs/client/react/useUtils
    */
   useUtils(): CreateReactUtils<TRouter, TSSRContext>;
+  /**
+   * Provides the tRPC client and `QueryClient` to the hooks.
+   * @see https://trpc.io/docs/client/react/setup#4-add-trpc-providers
+   */
   Provider: TRPCProvider<TRouter, TSSRContext>;
+  /**
+   * Same as `createTRPCClient`, typed for this router.
+   */
   createClient: typeof createTRPCClient<TRouter>;
+  /**
+   * @see https://trpc.io/docs/client/react/useQueries
+   */
   useQueries: TRPCUseQueries<TRouter>;
+  /**
+   * @see https://trpc.io/docs/client/react/suspense#usesuspensequeries
+   */
   useSuspenseQueries: TRPCUseSuspenseQueries<TRouter>;
 };
 
+/**
+ * The hooks object returned by {@link createTRPCReact}.
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ */
 export type CreateTRPCReact<
   TRouter extends AnyRouter,
   TSSRContext,
@@ -505,6 +525,19 @@ export function createHooksInternal<
   });
 }
 
+/**
+ * Creates typed React hooks for your router, built on TanStack React Query.
+ *
+ * @example
+ * ```ts
+ * export const trpc = createTRPCReact<AppRouter>();
+ * ```
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ * @see https://trpc.io/docs/client/react/setup
+ */
 export function createTRPCReact<
   TRouter extends AnyRouter,
   TSSRContext = unknown,

package/src/internals/context.tsx

@@ -46,6 +46,9 @@ interface TRPCUseUtilsOptions {
    */
   trpc?: TRPCRequestOptions;
 }
+/**
+ * Options for the `fetch` and `prefetch` helpers.
+ */
 export interface TRPCFetchQueryOptions<TOutput, TError>
   extends
     DistributiveOmit<FetchQueryOptions<TOutput, TError>, 'queryKey'>,
@@ -53,6 +56,9 @@ export interface TRPCFetchQueryOptions<TOutput, TError>
   //
 }
 
+/**
+ * Options for the `fetchInfinite` and `prefetchInfinite` helpers.
+ */
 export type TRPCFetchInfiniteQueryOptions<TInput, TOutput, TError> =
   DistributiveOmit<
     FetchInfiniteQueryOptions<
@@ -65,12 +71,18 @@ export type TRPCFetchInfiniteQueryOptions<TInput, TOutput, TError> =
     'queryKey' | 'initialPageParam'
   > &
     TRPCUseUtilsOptions & {
+      /**
+       * The cursor for the first page.
+       */
       initialCursor?: ExtractCursorType<TInput>;
     };
 
 /** @internal */
 export type SSRState = 'mounted' | 'mounting' | 'prepass' | false;
 
+/**
+ * Props shared by the tRPC React context and its `Provider`.
+ */
 export interface TRPCContextPropsBase<TRouter extends AnyRouter, TSSRContext> {
   /**
    * The `TRPCClient`
@@ -108,6 +120,9 @@ export type DecoratedTRPCContextProps<
   client: TRPCClient<TRouter>;
 };
 
+/**
+ * Props for the tRPC React context: the base props plus a `QueryClient`.
+ */
 export interface TRPCContextProps<
   TRouter extends AnyRouter,
   TSSRContext,
@@ -118,6 +133,9 @@ export interface TRPCContextProps<
   queryClient: QueryClient;
 }
 
+/**
+ * The keys of {@link TRPCContextPropsBase}.
+ */
 export const contextProps: (keyof TRPCContextPropsBase<any, any>)[] = [
   'client',
   'ssrContext',
@@ -353,4 +371,7 @@ export interface TRPCQueryUtils<TRouter extends AnyRouter> {
    */
   isMutating: (filters: { mutationKey: TRPCMutationKey }) => number;
 }
+/**
+ * The React context that holds the tRPC client and `QueryClient`.
+ */
 export const TRPCContext = React.createContext?.(null as any);

package/src/internals/getQueryKey.ts

@@ -100,11 +100,22 @@ type GetParams<TProcedureOrRouter extends ProcedureOrRouter> =
     : [];
 
 /**
- * Method to extract the query key for a procedure
- * @param procedureOrRouter - procedure or AnyRouter
- * @param input - input to procedureOrRouter
- * @param type - defaults to `any`
- * @see https://trpc.io/docs/v11/getQueryKey
+ * Returns the TanStack Query key for a procedure or router.
+ * @param procedureOrRouter - a procedure or router from `createTRPCReact`
+ * @param input - the procedure input. Leave it out to match every input in
+ * fuzzy operations like `invalidateQueries`.
+ * @param type - `'query'`, `'infinite'` or `'any'` (default). `'any'` leaves
+ * the type out of the key, so exact reads like `getQueryData` need the same
+ * input the query used and the matching type. Infinite query keys leave out
+ * `cursor` and `direction`.
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead, where
+ * each query procedure has a `queryKey()` method and each router has a
+ * `pathKey()` method.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ * @see https://trpc.io/docs/client/tanstack-react-query/usage#queryKey
+ * @see https://trpc.io/docs/client/react/getQueryKey
  */
 export function getQueryKey<TProcedureOrRouter extends ProcedureOrRouter>(
   procedureOrRouter: TProcedureOrRouter,
@@ -125,9 +136,14 @@ export type QueryKeyKnown<TInput, TType extends Exclude<QueryType, 'any'>> = [
 ];
 
 /**
- * Method to extract the mutation key for a procedure
- * @param procedure - procedure
- * @see https://trpc.io/docs/v11/getQueryKey#mutations
+ * Returns the TanStack Query mutation key for a procedure.
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead, where
+ * each mutation has a `mutationKey()` method.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ * @see https://trpc.io/docs/client/tanstack-react-query/usage#mutationKey
+ * @see https://trpc.io/docs/client/react/getQueryKey#mutations
  */
 export function getMutationKey<TProcedure extends DecoratedMutation<any>>(
   procedure: TProcedure,

package/src/rsc.tsx

@@ -74,6 +74,9 @@ type Caller<TRouter extends AnyRouter> = ReturnType<
 
 // ts-prune-ignore-next
 /**
+ * Creates a server-side caller that can also prefetch queries, plus a
+ * `HydrateClient` component that sends the prefetched data to the client.
+ *
  * @note This requires `@tanstack/react-query@^5.49.0`
  * @note Make sure to have `dehydrate.serializeData` and `hydrate.deserializeData`
  * set to your data transformer in your `QueryClient` factory.
@@ -91,6 +94,11 @@ type Caller<TRouter extends AnyRouter> = ReturnType<
  *     },
  *   });
  * ```
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ * @see https://trpc.io/docs/client/react/server-components
  */
 export function createHydrationHelpers<TRouter extends AnyRouter>(
   caller: AnyRouter extends TRouter

package/src/server/ssgProxy.ts

@@ -2,6 +2,7 @@ import type {
   DehydratedState,
   DehydrateOptions,
   QueryClient,
+  QueryFunctionContext,
 } from '@tanstack/react-query';
 import { dehydrate } from '@tanstack/react-query';
 import type { TRPCClient } from '@trpc/client';
@@ -27,6 +28,8 @@ import {
   createRecursiveProxy,
   run,
 } from '@trpc/server/unstable-core-do-not-import';
+import { getClientArgs } from '../internals/getClientArgs';
+import type { TRPCQueryKey } from '../internals/getQueryKey';
 import { getQueryKeyInternal } from '../internals/getQueryKey';
 import type {
   CreateTRPCReactQueryClientConfig,
@@ -37,11 +40,20 @@ import type {
 import { getQueryClient, getQueryType } from '../shared';
 
 type CreateSSGHelpersInternal<TRouter extends AnyRouter> = {
+  /**
+   * Call this router directly, without HTTP.
+   */
   router: TRouter;
+  /**
+   * The context to call procedures with.
+   */
   ctx: inferRouterContext<TRouter>;
 } & TransformerOptions<inferClientTypes<TRouter>>;
 
 interface CreateSSGHelpersExternal<TRouter extends AnyRouter> {
+  /**
+   * Call procedures through this tRPC client.
+   */
   client: TRPCClient<TRouter> | TRPCUntypedClient<TRouter>;
 }
 
@@ -76,8 +88,13 @@ type DecoratedProcedureSSGRecord<
 type AnyDecoratedProcedure = Pick<DecorateQueryProcedure<any, any>, SSGFns>;
 
 /**
- * Create functions you can use for server-side rendering / static generation
- * @see https://trpc.io/docs/v11/client/nextjs/server-side-helpers
+ * Creates helpers that fetch or prefetch queries on the server, for
+ * server-side rendering and static generation.
+ *
+ * @deprecated `@trpc/react-query` only gets bug fixes and will be removed in
+ * the next major version. Use `@trpc/tanstack-react-query` instead.
+ * @see https://trpc.io/docs/client/tanstack-react-query/migrating
+ * @see https://trpc.io/docs/client/nextjs/pages-router/server-side-helpers
  */
 export function createServerSideHelpers<TRouter extends AnyRouter>(
   opts: CreateServerSideHelpersOptions<TRouter>,
@@ -168,6 +185,20 @@ export function createServerSideHelpers<TRouter extends AnyRouter>(
     const queryFn = () =>
       resolvedOpts.query({ path: arrayPath.join('.'), input });
 
+    const infiniteQueryFn = ({
+      pageParam,
+      direction,
+    }: QueryFunctionContext<TRPCQueryKey, unknown>) => {
+      const initialCursor = (args[1] as Maybe<{ initialCursor?: unknown }>)
+        ?.initialCursor;
+      const [path, infiniteInput] = getClientArgs(
+        [arrayPath, { input }],
+        undefined,
+        { pageParam: pageParam ?? initialCursor, direction },
+      );
+      return resolvedOpts.query({ path, input: infiniteInput });
+    };
+
     const queryKey = getQueryKeyInternal(
       arrayPath,
       input,
@@ -181,7 +212,12 @@ export function createServerSideHelpers<TRouter extends AnyRouter>(
       },
       infiniteQueryOptions: () => {
         const args1 = args[1] as Maybe<any>;
-        return { ...args1, queryKey, queryFn };
+        return {
+          ...args1,
+          queryKey,
+          queryFn: infiniteQueryFn,
+          initialPageParam: args1?.initialCursor ?? null,
+        };
       },
       fetch: () => {
         const args1 = args[1] as Maybe<TRPCFetchQueryOptions<any, any>>;
@@ -194,7 +230,7 @@ export function createServerSideHelpers<TRouter extends AnyRouter>(
         return queryClient.fetchInfiniteQuery({
           ...args1,
           queryKey,
-          queryFn,
+          queryFn: infiniteQueryFn,
           initialPageParam: args1?.initialCursor ?? null,
         });
       },
@@ -209,7 +245,7 @@ export function createServerSideHelpers<TRouter extends AnyRouter>(
         return queryClient.prefetchInfiniteQuery({
           ...args1,
           queryKey,
-          queryFn,
+          queryFn: infiniteQueryFn,
           initialPageParam: args1?.initialCursor ?? null,
         });
       },

package/src/shared/hooks/types.ts

@@ -33,11 +33,17 @@ import type { JSX, ReactNode } from 'react';
 import type { TRPCContextProps } from '../../internals/context';
 import type { TRPCQueryKey } from '../../internals/getQueryKey';
 
+/**
+ * A page of data and the cursor that fetched it.
+ */
 export type OutputWithCursor<TData, TCursor = any> = {
   cursor: TCursor | null;
   data: TData;
 };
 
+/**
+ * tRPC options for a single hook call, passed as `trpc`.
+ */
 export interface TRPCReactRequestOptions
   // For RQ, we use their internal AbortSignals instead of letting the user pass their own
   extends Omit<TRPCRequestOptions, 'signal'> {
@@ -51,6 +57,9 @@ export interface TRPCReactRequestOptions
   abortOnUnmount?: boolean;
 }
 
+/**
+ * Adds the `trpc` option to TanStack Query options.
+ */
 export interface TRPCUseQueryBaseOptions {
   /**
    * tRPC-related options
@@ -58,6 +67,10 @@ export interface TRPCUseQueryBaseOptions {
   trpc?: TRPCReactRequestOptions;
 }
 
+/**
+ * Options for `useQuery`: TanStack Query options without `queryKey`, plus `trpc`.
+ * @see https://trpc.io/docs/client/react/useQuery
+ */
 export interface UseTRPCQueryOptions<
   TOutput,
   TData,
@@ -71,6 +84,10 @@ export interface UseTRPCQueryOptions<
     >,
     TRPCUseQueryBaseOptions {}
 
+/**
+ * Options for `useSuspenseQuery`.
+ * @see https://trpc.io/docs/client/react/suspense#usesuspensequery
+ */
 export interface UseTRPCSuspenseQueryOptions<TOutput, TData, TError>
   extends
     DistributiveOmit<
@@ -79,6 +96,10 @@ export interface UseTRPCSuspenseQueryOptions<TOutput, TData, TError>
     >,
     TRPCUseQueryBaseOptions {}
 
+/**
+ * Options for `usePrefetchQuery`.
+ * @see https://trpc.io/docs/client/react/suspense#component-level-prefetching-with-useprefetchquery
+ */
 export interface UseTRPCPrefetchQueryOptions<TOutput, TData, TError>
   extends
     DistributiveOmit<
@@ -100,6 +121,9 @@ export interface DefinedUseTRPCQueryOptions<
   initialData: InitialDataFunction<TQueryOptsData> | TQueryOptsData;
 }
 
+/**
+ * TanStack Query options with a tRPC query key.
+ */
 export interface TRPCQueryOptions<TData, TError>
   extends
     DistributiveOmit<QueryOptions<TData, TError, TData, any>, 'queryKey'>,
@@ -107,10 +131,17 @@ export interface TRPCQueryOptions<TData, TError>
   queryKey: TRPCQueryKey;
 }
 
+/**
+ * The type of the `cursor` field in a procedure's input.
+ */
 export type ExtractCursorType<TInput> = TInput extends { cursor?: any }
   ? TInput['cursor']
   : unknown;
 
+/**
+ * Options for `useInfiniteQuery`. Use `initialCursor` instead of `initialPageParam`.
+ * @see https://trpc.io/docs/client/react/useInfiniteQuery
+ */
 export interface UseTRPCInfiniteQueryOptions<TInput, TOutput, TError>
   extends
     DistributiveOmit<
@@ -124,9 +155,16 @@ export interface UseTRPCInfiniteQueryOptions<TInput, TOutput, TError>
       'queryKey' | 'initialPageParam'
     >,
     TRPCUseQueryBaseOptions {
+  /**
+   * The cursor for the first page.
+   */
   initialCursor?: ExtractCursorType<TInput>;
 }
 
+/**
+ * Options for `usePrefetchInfiniteQuery`.
+ * @see https://trpc.io/docs/client/react/suspense#component-level-prefetching-with-useprefetchinfinitequery
+ */
 export type UseTRPCPrefetchInfiniteQueryOptions<TInput, TOutput, TError> =
   DistributiveOmit<
     FetchInfiniteQueryOptions<
@@ -139,9 +177,16 @@ export type UseTRPCPrefetchInfiniteQueryOptions<TInput, TOutput, TError> =
     'queryKey' | 'initialPageParam'
   > &
     TRPCUseQueryBaseOptions & {
+      /**
+       * The cursor for the first page.
+       */
       initialCursor?: ExtractCursorType<TInput>;
     };
 
+/**
+ * Options for `useSuspenseInfiniteQuery`.
+ * @see https://trpc.io/docs/client/react/suspense#usesuspenseinfinitequery
+ */
 export interface UseTRPCSuspenseInfiniteQueryOptions<TInput, TOutput, TError>
   extends
     DistributiveOmit<
@@ -155,9 +200,16 @@ export interface UseTRPCSuspenseInfiniteQueryOptions<TInput, TOutput, TError>
       'queryKey' | 'initialPageParam'
     >,
     TRPCUseQueryBaseOptions {
+  /**
+   * The cursor for the first page.
+   */
   initialCursor?: ExtractCursorType<TInput>;
 }
 
+/**
+ * Options for `useMutation`.
+ * @see https://trpc.io/docs/client/react/useMutation
+ */
 export interface UseTRPCMutationOptions<
   TInput,
   TError,
@@ -168,6 +220,10 @@ export interface UseTRPCMutationOptions<
     UseMutationOptions<TOutput, TError, TInput, TContext>,
     TRPCUseQueryBaseOptions {}
 
+/**
+ * Options for `useSubscription`.
+ * @see https://trpc.io/docs/client/react/useSubscription#options
+ */
 export interface UseTRPCSubscriptionOptions<TOutput, TError> {
   /**
    * @deprecated
@@ -197,6 +253,10 @@ export interface UseTRPCSubscriptionOptions<TOutput, TError> {
   trpc?: Pick<TRPCRequestOptions, 'context'>;
 }
 
+/**
+ * Fields shared by every `useSubscription` result.
+ * @see https://trpc.io/docs/client/react/useSubscription#return-type
+ */
 export interface TRPCSubscriptionBaseResult<TOutput, TError> {
   status: 'idle' | 'connecting' | 'pending' | 'error';
   data: undefined | TOutput;
@@ -207,6 +267,9 @@ export interface TRPCSubscriptionBaseResult<TOutput, TError> {
   reset: () => void;
 }
 
+/**
+ * `useSubscription` result while the subscription is not running.
+ */
 export interface TRPCSubscriptionIdleResult<
   TOutput,
 > extends TRPCSubscriptionBaseResult<TOutput, null> {
@@ -215,6 +278,9 @@ export interface TRPCSubscriptionIdleResult<
   error: null;
 }
 
+/**
+ * `useSubscription` result while connecting or reconnecting.
+ */
 export interface TRPCSubscriptionConnectingResult<
   TOutput,
   TError,
@@ -224,6 +290,10 @@ export interface TRPCSubscriptionConnectingResult<
   error: TError | null;
 }
 
+/**
+ * `useSubscription` result while the subscription is active. It stays
+ * `pending` after data arrives, so `data` may be set.
+ */
 export interface TRPCSubscriptionPendingResult<
   TOutput,
 > extends TRPCSubscriptionBaseResult<TOutput, undefined> {
@@ -232,6 +302,9 @@ export interface TRPCSubscriptionPendingResult<
   error: null;
 }
 
+/**
+ * `useSubscription` result after an error that stopped the subscription.
+ */
 export interface TRPCSubscriptionErrorResult<
   TOutput,
   TError,
@@ -241,12 +314,19 @@ export interface TRPCSubscriptionErrorResult<
   error: TError;
 }
 
+/**
+ * The result of `useSubscription`. Check `status` to narrow it.
+ * @see https://trpc.io/docs/client/react/useSubscription#return-type
+ */
 export type TRPCSubscriptionResult<TOutput, TError> =
   | TRPCSubscriptionIdleResult<TOutput>
   | TRPCSubscriptionConnectingResult<TOutput, TError>
   | TRPCSubscriptionErrorResult<TOutput, TError>
   | TRPCSubscriptionPendingResult<TOutput>;
 
+/**
+ * Props for the `Provider` from `createTRPCReact`.
+ */
 export interface TRPCProviderProps<
   TRouter extends AnyRouter,
   TSSRContext,
@@ -255,10 +335,17 @@ export interface TRPCProviderProps<
   client: TRPCClient<TRouter> | TRPCUntypedClient<TRouter>;
 }
 
+/**
+ * The `Provider` component from `createTRPCReact`.
+ * @see https://trpc.io/docs/client/react/setup#4-add-trpc-providers
+ */
 export type TRPCProvider<TRouter extends AnyRouter, TSSRContext> = (
   props: TRPCProviderProps<TRouter, TSSRContext>,
 ) => JSX.Element;
 
+/**
+ * A function that creates a tRPC client.
+ */
 export type CreateClient<TRouter extends AnyRouter> = (
   opts: CreateTRPCClientOptions<TRouter>,
 ) => TRPCUntypedClient<TRouter>;
@@ -329,8 +416,14 @@ export type UseTRPCSuspenseInfiniteQueryResult<TData, TError, TInput> = [
 export type UseTRPCMutationResult<TData, TError, TVariables, TContext> =
   TRPCHookResult & UseMutationResult<TData, TError, TVariables, TContext>;
 
+/**
+ * Extra fields that tRPC adds to every hook result.
+ */
 export interface TRPCHookResult {
   trpc: {
+    /**
+     * The dot-separated procedure path, such as `post.byId`.
+     */
     path: string;
   };
 }

package/src/shared/polymorphism/routerLike.ts

@@ -15,6 +15,9 @@ export type RouterLike<TRouter extends AnyRouter> = RouterLikeInner<
   TRouter['_def']['_config']['$types'],
   TRouter['_def']['record']
 >;
+/**
+ * The record behind {@link RouterLike}.
+ */
 export type RouterLikeInner<
   TRoot extends AnyRootTypes,
   TRecord extends RouterRecord,

package/src/shared/proxy/utilsProxy.ts

@@ -62,6 +62,10 @@ import type {
   UnusedSkipTokenTRPCQueryOptionsOut,
 } from '../types';
 
+/**
+ * The `useUtils` helpers for one query procedure.
+ * @see https://trpc.io/docs/client/react/useUtils#helpers
+ */
 export type DecorateQueryProcedure<
   TRoot extends AnyRootTypes,
   TProcedure extends AnyQueryProcedure,
@@ -412,6 +416,10 @@ export type DecoratedProcedureUtilsRecord<
 type AnyDecoratedProcedure = DecorateQueryProcedure<any, any> &
   DecorateMutationProcedure<any, any>;
 
+/**
+ * What `useUtils()` returns: the context props plus helpers for every procedure.
+ * @see https://trpc.io/docs/client/react/useUtils
+ */
 export type CreateReactUtils<
   TRouter extends AnyRouter,
   TSSRContext,
@@ -423,12 +431,19 @@ export type CreateReactUtils<
   >
 >;
 
+/**
+ * What `createTRPCQueryUtils` returns.
+ * @see https://trpc.io/docs/client/react/createTRPCQueryUtils
+ */
 export type CreateQueryUtils<TRouter extends AnyRouter> =
   DecoratedProcedureUtilsRecord<
     TRouter['_def']['_config']['$types'],
     TRouter['_def']['record']
   >;
 
+/**
+ * Maps a `useUtils` helper name to the kind of query it works on.
+ */
 export const getQueryType = (
   utilName: keyof AnyDecoratedProcedure,
 ): QueryType => {