Type Alias: WSSHandlerOptions<TRouter>

WSSHandlerOptions<TRouter>: WSConnectionHandlerOptions<TRouter> & object

The options of applyWSSHandler.

Type declaration

optional dangerouslyDisablePong: boolean

Stops answering clients' pings. Meant for tests.

false

optional experimental_encoder: Encoder

Encodes and decodes messages, for formats other than JSON. Experimental: it may change in any release.

jsonEncoder

optional keepAlive: object

Sends pings to each client and closes connections that stop answering.

enabled: boolean

Whether to send pings.

false

optional pingMs: number

How long a connection can be quiet before a ping, in milliseconds.

30_000

optional pongWaitMs: number

How long to wait for a pong before closing the connection, in milliseconds.

5_000

optional prefix: string

Only connections whose URL starts with this are served.

wss: WebSocketServer

The ws server to serve the router on.

Type Parameter
`TRouter` extends `AnyTRPCRouter`