Skip to content
tRPC

Partners

Interface: TRPCContextPropsBase<TRouter, TSSRContext>

On this page

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

Props shared by the tRPC React context and its Provider.

Extended by

Type Parameters

Type Parameter
TRouter extends AnyRouter
TSSRContext

Properties

abortOnUnmount?

optional abortOnUnmount: boolean

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

Deprecated

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

Default

false

client

client: TRPCUntypedClient<TRouter>

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

The TRPCClient


ssrContext?

optional ssrContext: null | TSSRContext

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

The SSR context when server-side rendering

Default

null

ssrState?

optional ssrState: SSRState

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

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

false