Interface SocketAPI<MessageT, RecipientT>

A simple socket interface for sending messages

interface SocketAPI<MessageT, RecipientT> {
sendMessage(options): void;
}

Type Parameters

MessageT
RecipientT

Implemented by

DefaultSocketIOAPI

Index

Methods

Methods

sendMessage

sendMessage(options): void
Send a message to a list of recipients Recipients can be arbitrary, but are usually a subscription object on chat service, or a transmission object on notification service
Parameters
- options: {
  message: MessageT;
  recipients: RecipientT[];
  }
  - message: MessageT
    The message to send
  - recipients: RecipientT[]
    List of recipients to send the message to
Returns void
- Defined in src/socket/types.ts:10

Generated using TypeDoc