Skip to content
tRPC

Partners

Function: applyWSSHandler()

On this page

applyWSSHandler<TRouter>(opts): object

Defined in: packages/server/src/adapters/ws.ts:909

Serves a router on a ws WebSocket server. Returns broadcastReconnectNotification(), which tells every client to reconnect, for example before a deploy.

Type Parameters

Type Parameter
TRouter extends AnyTRPCRouter

Parameters

ParameterType
optsWSSHandlerOptions<TRouter>

Returns

object

broadcastReconnectNotification()

broadcastReconnectNotification: () => void

Returns

void

Example

const wss = new WebSocketServer({ port: 3001 });
const handler = applyWSSHandler({ wss, router: appRouter, createContext });
process.on('SIGTERM', () => {
  handler.broadcastReconnectNotification();
  wss.close();
});

See

https://trpc.io/docs/server/websockets#creating-a-websocket-server