Class: TRPCBuilder<TContext, TMeta>
On this page
Defined in: packages/server/src/unstable-core-do-not-import/initTRPC.ts:135
The type of initTRPC. Chain .context() and .meta() to set their
types, then call .create().
Type Parameters
| Type Parameter |
|---|
TContext extends object |
TMeta extends object |
Constructors
new TRPCBuilder()
new TRPCBuilder<
TContext,TMeta>():TRPCBuilder<TContext,TMeta>
Returns
TRPCBuilder<TContext, TMeta>
Methods
context()
context<
TNewContext>():TRPCBuilder<TNewContextextendsContextCallback?Unwrap<TNewContext<TNewContext>> :TNewContext,TMeta>
Defined in: packages/server/src/unstable-core-do-not-import/initTRPC.ts:141
Sets the type of the context every procedure gets. Pass the type, or
the type of your createContext function.
Type Parameters
| Type Parameter |
|---|
TNewContext extends object | ContextCallback |
Returns
TRPCBuilder<TNewContext extends ContextCallback ? Unwrap<TNewContext<TNewContext>> : TNewContext, TMeta>
See
https://trpc.io/docs/server/context#defining-the-context-type
create()
create<
TOptions>(opts?):TRPCRootObject<TContext,TMeta,TOptions>
Defined in: packages/server/src/unstable-core-do-not-import/initTRPC.ts:161
Creates the root object, which holds the builders for your procedures, middlewares and routers.
Type Parameters
| Type Parameter |
|---|
TOptions extends RuntimeConfigOptions<TContext, TMeta> |
Parameters
| Parameter | Type |
|---|---|
opts? | ValidateShape<TOptions, RuntimeConfigOptions<TContext, TMeta>> |
Returns
TRPCRootObject<TContext, TMeta, TOptions>
See
https://trpc.io/docs/server/routers#initialize-trpc
meta()
meta<
TNewMeta>():TRPCBuilder<TContext,TNewMeta>
Defined in: packages/server/src/unstable-core-do-not-import/initTRPC.ts:152
Sets the type of the metadata procedures can set with .meta().
Type Parameters
| Type Parameter |
|---|
TNewMeta extends object |
Returns
TRPCBuilder<TContext, TNewMeta>