Skip to main content
Version: 11.x

Interface: TRPCContextPropsBase<TRouter, TSSRContext>

Extended By

Type parameters

Parameter
TRouter extends AnyRouter
TSSRContext

Properties

abortOnUnmount

optional abortOnUnmount: boolean

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

Source

packages/react-query/src/internals/context.tsx:79


client

client: TRPCUntypedClient< TRouter >

The TRPCClient

Source

packages/react-query/src/internals/context.tsx:59


ssrContext

optional ssrContext: null | TSSRContext

The SSR context when server-side rendering

Default

ts
null
ts
null

Source

packages/react-query/src/internals/context.tsx:64


ssrState

optional ssrState: SSRState

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

Source

packages/react-query/src/internals/context.tsx:73


Generated using TypeDoc and typedoc-plugin-markdown