Class: CollabClient

The client that manages sending local editor state changes to the remote server and merging remote changes into local editor state.

Constructors

new CollabClient(config: CollabClientConfig): CollabClient;

CollabClient

listen(editorState: EditorState, signal?: AbortSignal): Promise<void>;

Start listening for remote commits. This function should only be called once.

EditorState

AbortSignal

Promise<void>

send(editorState: EditorState): Promise<void>;

Send local editor state changes to the remote server.

EditorState

Promise<void>

update(config: Partial<Omit<CollabClientConfig, "listener">>): void;

Updates the desired portion of the client's CollabClientConfig. For example, this can be used to update the auth headers used by sendCommit.

Partial<Omit<CollabClientConfig, "listener">>

void