Broadcast Decorator

The broadcast decorator enables you to broadcast a message to every peer on your namespace (including the peer).

The decorator accepts a string event - This is the event that will be sent back to the client along with the data.

Usage

@Namespace('/foo') // register the namespace
@Controller('/api/playground')
export default class DummyController {
  @Broadcast('test')
  public async onMessage(incomingMessage: unknown, peer: { id: string; ip: string; }): Promise<Record<string, string>> {
    // { foo: 'bar' } will be emitted to every peer on the namespace
    // including the sender
    return { foo: 'bar' }
  }
}

On your client side, messages will be received with the following pattern:

{ 
  event: 'test', // the event you specified when using the decorator
  data: { foo: 'bar' } // the data returning from your function
};

See Also

• Websocket Plugin - Documentation of the Websocket Plugin
• Namespace Decorator - Documentation of the Namespace decorator
• OnConnectionAttempt Decorator - Documentation of the OnConnectionAttempt decorator
• Message Decorator - Documentation of the Message decorator
• Emit Decorator - Documentation of the Emit decorator
• BroadcastOthers Decorator - Documentation of the BroadcastOthers decorator