BroadcastChannel
@rotorsoft/act-root / act-http/src/sse / BroadcastChannel
Class: BroadcastChannel<S>
Defined in: libs/act-http/src/sse/broadcast.ts:68
Type Parameters
S
S extends BroadcastState = BroadcastState
Constructors
Constructor
new BroadcastChannel<
S>(options?):BroadcastChannel<S>
Defined in: libs/act-http/src/sse/broadcast.ts:79
Parameters
options?
cache_size?
number
Deprecated alias of cacheSize — removal in the next major. When
both are given, cacheSize wins.
Deprecated
use cacheSize
cacheSize?
number
onOverlayMiss?
(streamId) => void
Called when overlay() finds no cached baseline for the stream, so
the update cannot be broadcast. Live subscribers receive nothing and
have no way to notice — a host that cares should raise cacheSize,
re-publish the stream, or push the viewers to refetch. Defaults to a
no-op so existing behavior is unchanged apart from being observable.
onSubscriberError?
(error, streamId) => void
Called when a subscriber callback throws. The frame is still delivered
to every other subscriber and the publish still returns normally — a
bad consumer must not break the publisher (#1423). Defaults to the
framework's log() port, so it lands wherever the host already
routes framework logs.
Returns
BroadcastChannel<S>
Accessors
cache
Get Signature
get cache():
StateCache<S>
Defined in: libs/act-http/src/sse/broadcast.ts:232
Direct access to the state cache (for app-specific reads like presence).
Returns
StateCache<S>
Methods
get_state()
get_state(
streamId):S|undefined
Defined in: libs/act-http/src/sse/broadcast.ts:227
Parameters
streamId
string
Returns
S | undefined
Deprecated
use state — removal in the next major
get_subscriber_count()
get_subscriber_count(
streamId):number
Defined in: libs/act-http/src/sse/broadcast.ts:222
Parameters
streamId
string
Returns
number
Deprecated
use subscriberCount — removal in the next major
overlay()
overlay(
streamId,overlay_patch):PatchMessage<S> |undefined
Defined in: libs/act-http/src/sse/broadcast.ts:146
Publish a state update that doesn't change the event version (e.g. presence overlay, computed field refresh). Uses the same version as the cached state, single entry.
Parameters
streamId
string
overlay_patch
Partial<S>
Returns
PatchMessage<S> | undefined
publish()
publish(
streamId,state,patches?):PatchMessage<S>
Defined in: libs/act-http/src/sse/broadcast.ts:122
Publish domain patches from a commit. patches[i] corresponds to version baseV + i + 1.
Parameters
streamId
string
The event store stream ID
state
S
Full state with _v set from snap.event.version
patches?
Partial<S>[] = []
Array of domain patches, one per emitted event
Returns
PatchMessage<S>
publish_overlay()
publish_overlay(
streamId,overlay_patch):PatchMessage<S> |undefined
Defined in: libs/act-http/src/sse/broadcast.ts:214
Parameters
streamId
string
overlay_patch
Partial<S>
Returns
PatchMessage<S> | undefined
Deprecated
use overlay — removal in the next major
state()
state(
streamId):S|undefined
Defined in: libs/act-http/src/sse/broadcast.ts:209
Get the cached state for a stream (for reconnects / initial SSE yield).
Parameters
streamId
string
Returns
S | undefined
subscribe()
subscribe(
streamId,cb): () =>void
Defined in: libs/act-http/src/sse/broadcast.ts:192
Subscribe to broadcast messages for a stream. Returns a cleanup function that removes the subscription.
Parameters
streamId
string
cb
Subscriber<S>
Returns
() => void
subscriberCount()
subscriberCount(
streamId):number
Defined in: libs/act-http/src/sse/broadcast.ts:204
Get the number of subscribers for a stream.
Parameters
streamId
string
Returns
number