Documentation / @zerotal/broadcasting / BroadcastFake
Class: BroadcastFake
Defined in: broadcasting/src/BroadcastFake.ts:20
In-test fake that records broadcast calls without requiring a WS server.
Example
const fake = Broadcast.fake();
// ... controller action that calls Broadcast.send(new PostUpdated(post))
fake.assertBroadcast('PostUpdated', 'posts');
fake.assertNothingBroadcast();
Constructors
Constructor
new BroadcastFake():
BroadcastFake
Returns
BroadcastFake
Methods
to()
to(
channel,eventName,data?,_opts?):void
Defined in: broadcasting/src/BroadcastFake.ts:23
Parameters
channel
string
eventName
string
data?
unknown = {}
_opts?
exceptSocketId?
string
Returns
void
send()
send(
event,opts?):void
Defined in: broadcasting/src/BroadcastFake.ts:32
Parameters
event
opts?
exceptSocketId?
string
Returns
void
recorded()
recorded():
RecordedBroadcast[]
Defined in: broadcasting/src/BroadcastFake.ts:42
Return all recorded broadcasts.
Returns
reset()
reset():
void
Defined in: broadcasting/src/BroadcastFake.ts:47
Reset recorded broadcasts.
Returns
void
assertBroadcast()
assertBroadcast(
eventName,channel?,data?):void
Defined in: broadcasting/src/BroadcastFake.ts:60
Assert that an event was broadcast on the given channel (and optionally with given data).
Parameters
eventName
string
channel?
string
data?
Record<string, unknown>
Returns
void
Example
fake.assertBroadcast('PostUpdated', 'posts');
fake.assertBroadcast('PostUpdated', 'posts', { id: 1 });
assertNotBroadcast()
assertNotBroadcast(
eventName,channel?):void
Defined in: broadcasting/src/BroadcastFake.ts:87
Assert that the given event was NOT broadcast.
Parameters
eventName
string
channel?
string
Returns
void
assertNothingBroadcast()
assertNothingBroadcast():
void
Defined in: broadcasting/src/BroadcastFake.ts:99
Assert that no broadcasts were recorded.
Returns
void
assertBroadcastCount()
assertBroadcastCount(
count):void
Defined in: broadcasting/src/BroadcastFake.ts:109
Assert that exactly count broadcasts were recorded.
Parameters
count
number
Returns
void