Documentation
Use
Ws
Functions
useServer

Function: useServer()

useServer<P, E>(options, ws, keepAlive): Disposable

Defined in: src/use/ws.ts:40

Use the server on a ws ws server. This is a basic starter, feel free to copy the code over and adjust it to your needs

Type Parameters

P extends undefined | Record<string, unknown> = undefined | Record<string, unknown>

E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>

Parameters

options

ServerOptions<P, Extra & Partial<E>>

ws

WebSocketServer

keepAlive

number = 12_000

The timeout between dispatched keep-alive messages. Internally uses the ws Ping and Pongs to check that the link between the clients and the server is operating and to prevent the link from being broken due to idling.

Default

12_000 // 12 seconds

Returns

Disposable