Skip to content
actor-ts

ServerWebSocketActorOptions

Defined in: src/io/broker/ServerWebSocketActor.ts:61

Properties

Section titled “Properties”

onError?

Section titled “onError?”

readonly optional onError?: (err) => void

Defined in: src/io/broker/ServerWebSocketActor.ts:76

Optional callback fired when the socket emits an error. Useful for backend-specific telemetry; the actor still proceeds to stop unless you turn stopOnSocketClose off.

Parameters

Section titled “Parameters”
err
Section titled “err”

Error

Returns

Section titled “Returns”

void

stopOnSocketClose?

Section titled “stopOnSocketClose?”

readonly optional stopOnSocketClose?: boolean

Defined in: src/io/broker/ServerWebSocketActor.ts:70

Stop the actor when the socket closes. Default true — the usual case where the actor exists solely to bridge one connection. Flip to false to handle close yourself (e.g. when an outer supervisor wants to react before teardown).

target?

Section titled “target?”

readonly optional target?: ActorRef<WebSocketFrame>

Defined in: src/io/broker/ServerWebSocketActor.ts:63

Subscriber that receives every inbound text/binary frame.