github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-24 18:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

fix: add docs to sendMessage

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2023-07-05 21:24:46 +02:00
parent 823b8e5ad5
commit 57f7734f7f
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
commons/src/message-transporters/message-transporter.ts
View file

@ -34,6 +34,13 @@ export class MessageTransporter extends EventEmitter2<MessageEventPayloadMap> {
private otherSideReady = false private otherSideReady = false
private readyInterval: NodeJS.Timer | undefined private readyInterval: NodeJS.Timer | undefined
/**
* Send a message to the other side using the currently set message transporter.
*
* @param content The complete message to send
* @throws Error if this or the other side are not ready yet and the message is not a READY_ANSWER or READY_REQUEST
* @throws Error if no transport adapter has been set
*/
public sendMessage<M extends MessageType>(content: Message<M>): void { public sendMessage<M extends MessageType>(content: Message<M>): void {
if (!this.isConnected()) { if (!this.isConnected()) {
this.onDisconnecting() this.onDisconnecting()