Interface: WithTRPCSSROptions<TRouter>

Extends

• WithTRPCOptions< TRouter >

Type parameters

Parameter
TRouter extends AnyRouter

Properties

abortOnUnmount

optional abortOnUnmount: boolean

Abort all queries when unmounting

Default

ts
false

ts
false

Source

react-query/dist/shared/types.d.ts:41

Inherited from

WithTRPCOptions.abortOnUnmount

---

config

config: (info) => WithTRPCConfig< TRouter >

Parameters

Parameter	Type
info	object
info.ctx?	NextPageContext

Returns

WithTRPCConfig< TRouter >

Source

next/src/withTRPC.tsx:67

Inherited from

WithTRPCOptions.config

---

context

optional context: Context< any >

Override the default context provider

Default

ts
undefined

ts
undefined

Source

react-query/dist/shared/types.d.ts:46

Inherited from

WithTRPCOptions.context

---

overrides

optional overrides: object

Override behaviors of the built-in hooks

Type declaration

overrides.useMutation

optional useMutation: Partial< UseMutationOverride >

Source

react-query/dist/shared/types.d.ts:34

Inherited from

WithTRPCOptions.overrides

---

reactQueryContext

optional reactQueryContext: Context< undefined | QueryClient >

Override the default React Query context

Default

ts
undefined

ts
undefined

Source

react-query/dist/shared/types.d.ts:51

Inherited from

WithTRPCOptions.reactQueryContext

---

responseMeta

optional responseMeta: (opts) => ResponseMeta

Parameters

Parameter	Type
opts	object
opts.clientErrors	TRPCClientError< TRouter >[]
opts.ctx	NextPageContext

Returns

ResponseMeta

Source

next/src/withTRPC.tsx:73

---

ssr

ssr: true

Source

next/src/withTRPC.tsx:72

---

unstable_overrides

optional unstable_overrides: object

Override behaviors of the built-in hooks

Deprecated

use overrides instead

Type declaration

unstable_overrides.useMutation

optional useMutation: Partial< UseMutationOverride >

Source

react-query/dist/shared/types.d.ts:28

Inherited from

WithTRPCOptions.unstable_overrides

---

Generated using TypeDoc and typedoc-plugin-markdown