Skip to main content
Version: 11.x

Interface: TRPCProviderProps<TRouter, TSSRContext>

Extends

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:80

Inherited from

TRPCContextProps.abortOnUnmount


children

children: ReactNode

Source

packages/react-query/src/shared/hooks/types.ts:147


client

client: TRPCUntypedClient< TRouter >

The TRPCClient

Source

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

Inherited from

TRPCContextProps.client


queryClient

queryClient: QueryClient

The react-query QueryClient

Source

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

Inherited from

TRPCContextProps.queryClient


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:65

Inherited from

TRPCContextProps.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:74

Inherited from

TRPCContextProps.ssrState


Generated using TypeDoc and typedoc-plugin-markdown