Skip to main content
Version: 11.x

Interface: TRPCContextProps<TRouter, TSSRContext>

Defined in: packages/react-query/src/internals/context.tsx:110

Extends

Type Parameters

Type Parameter
TRouter extends AnyRouter
TSSRContext

Properties

abortOnUnmount?

optional abortOnUnmount: boolean

Defined in: packages/react-query/src/internals/context.tsx:97

Deprecated

pass abortOnUnmount to createTRPCReact instead Abort loading query calls when unmounting a component - usually when navigating to a new page

Default

ts
false
ts
false

Inherited from

TRPCContextPropsBase.abortOnUnmount


client

client: TRPCUntypedClient<TRouter>

Defined in: packages/react-query/src/internals/context.tsx:77

The TRPCClient

Inherited from

TRPCContextPropsBase.client


queryClient

queryClient: QueryClient

Defined in: packages/react-query/src/internals/context.tsx:115

The react-query QueryClient


ssrContext?

optional ssrContext: null | TSSRContext

Defined in: packages/react-query/src/internals/context.tsx:82

The SSR context when server-side rendering

Default

ts
null
ts
null

Inherited from

TRPCContextPropsBase.ssrContext


ssrState?

optional ssrState: SSRState

Defined in: packages/react-query/src/internals/context.tsx:91

State of SSR hydration.

  • false if not using SSR.
  • prepass when doing a prepass to fetch queries' data
  • mounting before TRPCProvider has been rendered on the client
  • mounted when the TRPCProvider has been rendered on the client

Default

ts
false
ts
false

Inherited from

TRPCContextPropsBase.ssrState