Skip to main content
zerotal

Documentation

Documentation / @zerotal/broadcasting / BroadcastEvent

Interface: BroadcastEvent

Defined in: broadcasting/src/types.ts:18

Implement this interface on any event class to make it broadcastable.

Example

export class PostUpdated implements BroadcastEvent {
  constructor(private post: Post) {}

  broadcastOn() { return channel('posts'); }
  broadcastAs() { return 'PostUpdated'; }
  broadcastWith() { return { id: this.post.id, title: this.post.title }; }
}

// Dispatch
Broadcast.send(new PostUpdated(post));

Extended by

Methods

broadcastOn()

broadcastOn(): string | string[]

Defined in: broadcasting/src/types.ts:20

Channel name(s) to broadcast on. Use channel(), privateChannel(), or presenceChannel().

Returns

string | string[]

broadcastAs()?

optional broadcastAs(): string

Defined in: broadcasting/src/types.ts:22

Optional — defaults to the class constructor name.

Returns

string

broadcastWith()?

optional broadcastWith(): object

Defined in: broadcasting/src/types.ts:24

Data to include in the broadcast payload. Defaults to {}.

Returns

object