Skip to main content
Version: 11.x

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

Inherited from

WithTRPCOptions.abortOnUnmount


config

config: (info) => WithTRPCConfig< TRouter >

Parameters

ParameterType
infoobject
info.ctx?NextPageContext

Returns

WithTRPCConfig< TRouter >

Source

next/src/withTRPC.tsx:60

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

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

Inherited from

WithTRPCOptions.overrides


responseMeta

optional responseMeta: (opts) => ResponseMeta

Parameters

ParameterType
optsobject
opts.clientErrorsTRPCClientError< TRouter >[]
opts.ctxNextPageContext

Returns

ResponseMeta

Source

next/src/withTRPC.tsx:66


ssr

ssr: true | (opts) => boolean | Promise< boolean >

Source

next/src/withTRPC.tsx:65


Generated using TypeDoc and typedoc-plugin-markdown