websocket
Public WebSocket API surface. Internals (session actor, connection
impl, wiring, socket adapter, message signals) are intentionally NOT
re-exported — users interact only through websocket(),
WebsocketServerActor, the WebsocketConnection handle, and the codecs.
Call Signature
Section titled “Call Signature”websocket<
TOut,TIn,TSelf>(target,options?):Route
Defined in: src/http/websocket/WebsocketRoute.ts:26
websocket(target) — mount at the enclosing path.
Type Parameters
Section titled “Type Parameters”TOut
TIn
TSelf = never
Parameters
Section titled “Parameters”target
Section titled “target”WebsocketServerRef<TOut, TIn, TSelf>
options?
Section titled “options?”WebsocketRouteOptions<TOut, TIn>
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”websocket<
TOut,TIn,TSelf>(routePath,target,options?):Route
Defined in: src/http/websocket/WebsocketRoute.ts:31
websocket('/ws', target) — sugar for path('/ws', websocket(target)).
Type Parameters
Section titled “Type Parameters”TOut
TIn
TSelf = never
Parameters
Section titled “Parameters”routePath
Section titled “routePath”string
target
Section titled “target”WebsocketServerRef<TOut, TIn, TSelf>
options?
Section titled “options?”WebsocketRouteOptions<TOut, TIn>