@hocuspocus/common
Version:
shared code for multiple Hocuspocus packages
23 lines (22 loc) • 1.03 kB
TypeScript
import type { Encoder } from 'lib0/encoding';
import type { Awareness } from 'y-protocols/awareness';
import type Document from './Document.ts';
export declare class OutgoingMessage {
encoder: Encoder;
type?: number;
category?: string;
constructor(documentName: string);
createSyncMessage(): OutgoingMessage;
createSyncReplyMessage(): OutgoingMessage;
createAwarenessUpdateMessage(awareness: Awareness, changedClients?: Array<any>): OutgoingMessage;
writeQueryAwareness(): OutgoingMessage;
writeAuthenticated(readonly: boolean): OutgoingMessage;
writePermissionDenied(reason: string): OutgoingMessage;
writeFirstSyncStepFor(document: Document): OutgoingMessage;
writeUpdate(update: Uint8Array): OutgoingMessage;
writeStateless(payload: string): OutgoingMessage;
writeBroadcastStateless(payload: string): OutgoingMessage;
writeSyncStatus(updateSaved: boolean): OutgoingMessage;
writeCloseMessage(reason: string): OutgoingMessage;
toUint8Array(): Uint8Array;
}