y-generic-sync

Sync Yjs over any communication channel.

y-generic-sync is a sync provider for Yjs that leaves the choice of network channel (such as websocket, WebRTC, socket.io, broadcast-channel, Node.JS sockets...) entirely up to you. You provide a compatible interface to send and receive messages with other peers, and y-generic-sync will send the messages that are required to sync your document.

This library is a work in progress and the API may change in future versions.

Get started

Installation

npm install y-generic-sync --save

Example

import * as Y from 'yjs';
import GenericSyncProvider from 'y-generic-sync';

const doc = Y.Doc();

const syncProvider = new GenericSyncProvider(doc);

syncProvider.on('broadcast', (bytes) => {
    // Implement your own code to broadcast `bytes` (a Uint8Array).
    // Be sure to send the message to all other peer.
});

// When messages are received from other peers, pass them into the sync provider
myCustomChannelImplementation.on('message', bytes => {
    syncProvider.onMessage(bytes);
});

// Call onConnecting() when the communication channel is being set up
syncProvider.onConnecting();

// Call onConnect() once the communication channel is open and messages can be sent/received.
// This function kicks off the sync process.
syncProvider.onConnect();

// Call onDisconnect() when the communication channel closes
syncProvider.onDisconnect();

See the examples folder for a complete sample implementation using BroadcastChannel to sync between browser tabs.