Skip to content

createConnectRouter

createConnectRouter<ConnectConfigurationSchema>(options): BuiltRouter<object, DecorateCreateRouterOptions<object>>

This function creates a tRPC router you can embed into your application router.

The tRPC methods exposed by this router can be passed to ConnectedConnectForm; when you do so, the form will use these methods to automatically query for existing Connect configuration and handle form submissions.

Type Parameters

Type Parameter
ConnectConfigurationSchema extends ZodObject<any, UnknownKeysParam, ZodTypeAny, object, object>

Parameters

ParameterTypeDescription
optionsCreateConnectRouterOptions<ConnectConfigurationSchema>

Returns

BuiltRouter<object, DecorateCreateRouterOptions<object>>

NameType
ctxNetlifySDKContext<unknown, unknown, output<ConnectConfigurationSchema>>
errorShapeDefaultErrorShape
metaobject
transformerfalse

Example

endpoints/trpc.ts
import { createConnectRouter } from "@netlify/sdk/ui/functions/trpc";
import { ConnectConfigurationSchema } from "../schema/connect.js";
import { router } from "./trpc.js";
export const appRouter = router({
connect: createConnectRouter({ schema: ConnectConfigurationSchema }),
// ...
});