API reference / @chanx-js/server / testing / captureBroadcastEvents

Function: captureBroadcastEvents()

function captureBroadcastEvents<C>(
   app, 
   consumer, 
   __namedParameters?
): Capture<CapturedBroadcastEvent<EventsOf<C>>>;

Defined in: packages/server/src/testing.ts:202

Record a consumer's broadcastEvent() calls, to assert on what was sent rather than on what a second client received. Suppressed by default: recorded, not delivered.

Type Parameters

Type Parameter
C extends ConsumerLike

Parameters

Parameter	Type
app	Chanx
consumer	C
__namedParameters	{ suppress?: boolean; }
__namedParameters.suppress?	boolean

Returns

Capture<CapturedBroadcastEvent<EventsOf<C>>>