Type Alias: WSSHandlerOptions<TRouter>

WSSHandlerOptions<TRouter>: WSConnectionHandlerOptions<TRouter> & object

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

Web socket server handler

Type declaration

dangerouslyDisablePong?

optional dangerouslyDisablePong: boolean

Disable responding to ping messages from the client Not recommended - this is mainly used for testing

Default

ts
false

ts
false

experimental_encoder?

optional experimental_encoder: Encoder

Custom encoder for wire encoding (e.g. custom binary formats)

Default

ts
jsonEncoder

ts
jsonEncoder

keepAlive?

optional keepAlive: object

keepAlive.enabled

enabled: boolean

Enable heartbeat messages

Default

ts
false

ts
false

keepAlive.pingMs?

optional pingMs: number

Heartbeat interval in milliseconds

Default

ts
30_000

ts
30_000

keepAlive.pongWaitMs?

optional pongWaitMs: number

Terminate the WebSocket if no pong is received after this many milliseconds

Default

ts
5_000

ts
5_000

prefix?

optional prefix: string

wss

wss: ws.WebSocketServer

Type Parameters

Type Parameter
TRouter extends AnyTRPCRouter