broadcast

Description

Broadcast (emit) messages to the server. By default, it broadcasts to the 'message' topic.

Usage

Basic Usage:

import { from } from 'rxjs';
import { broadcast, ws } from '@buccaneer/rxws';

const messagesToSend$ = from([
  {body: 'data'},
  {body: 'more data'},
]);
const ws$ = ws({url: 'wss://mysite.com'});
const messages$ = ws$.pipe(
  broadcast(messagesToSend$)
);

messages$.subscribe(); // this will attempt to send the messages to the server

API

broadcast(
  messagesToSend$<Observable>,
  topic<String> = 'message'
)

Since

1.0

Parameters

• messagesToSend$<Observable>: An Observable containing messages that will be sent to the server (whenever a message is emitted)

• topic<String>: The topic to which the events should be published. Defaults to 'message'.

Options

None

Returns

{topic<String>,message<Any>}