nephele-y-websocket v0.0.23

y-websocket :tophat:

WebSocket Provider for Trip Yjs

Quick Start

Install dependencies

npm i nephele-y-websocket

Client Code:

import * as Y from 'yjs'
import { WebsocketProvider } from 'nephele-y-websocket'

const doc = new Y.Doc()
const wsProvider = new WebsocketProvider('ws://localhost:1234', doc)

// fetch authorized doc token, then
wsProvider.connect(docToken)

wsProvider.on('status', event => {
  console.log(event.status) // logs "connected" or "disconnected"
})

API

import { WebsocketProvider } from 'nephele-y-websocket'

wsOpts = {
  // Set this to `false` if you want to connect manually using wsProvider.connect()
  connect: true,
  // Specify a query-string that will be url-encoded and attached to the `serverUrl`
  // I.e. params = { auth: "bearer" } will be transformed to "?auth=bearer"
  params: {}, // Object<string,string>
  // You may polyill the Websocket object (https://developer.mozilla.org/en-US/docs/Web/API/WebSocket).
  // E.g. In nodejs, you could specify WebsocketPolyfill = require('ws')
  WebsocketPolyfill: Websocket,
  // Specify an existing Awareness instance - see https://github.com/yjs/y-protocols
  awareness: new awarenessProtocol.Awareness(ydoc)
}