Class: RedisBroadcastManager

A broadcast manager that uses a Redis cluster as a message broker via Redis's pub/sub.

When a client connects it specifies the document id to listen to.

When changes are submitted to a document all listeners for that document id are notified that there is an update.

Constructors

new RedisBroadcastManager(config: RedisBroadcastManagerConfig): RedisBroadcastManager;

RedisBroadcastManager

broadcastCommit(docId: string, commitJSON: CommitJSON): Promise<void>;

string

CommitJSON

Promise<void>

connect(): Promise<void>;

Promise<void>

createCommitListener(docId: string, version: number): Promise<{
  abort: () => Promise<void>;
  listen: () => Promise<boolean>;
}>;

string

number

Promise<{ abort: () => Promise<void>; listen: () => Promise<boolean>; }>