Interface: TRPCContextProps<TRouter, TSSRContext>

Extends

• TRPCContextPropsBase< TRouter, TSSRContext >

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

Inherited from

TRPCContextPropsBase.abortOnUnmount

---

client

client: TRPCUntypedClient< TRouter >

The TRPCClient

Source

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

Inherited from

TRPCContextPropsBase.client

---

queryClient

queryClient: QueryClient

The react-query QueryClient

Source

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

---

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

Inherited from

TRPCContextPropsBase.ssrContext

---

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

Inherited from

TRPCContextPropsBase.ssrState

---

Generated using TypeDoc and typedoc-plugin-markdown