Class YSweetProvider

Websocket Provider for Yjs. Creates a websocket connection to sync the shared document. The document name is attached to the provided url. I.e. the following example creates a websocket connection to http://localhost:1234/my-document-name

Example

import * as Y from 'yjs'
import { YSweetProvider } from 'y-websocket'
const doc = new Y.Doc()
const provider = new YSweetProvider('http://localhost:1234', 'my-document-name', doc)

Hierarchy

  • Observable<string>
    • YSweetProvider

Constructors

constructor

Properties

_WS _awarenessUpdateHandler _bcSubscriber _checkInterval _observers _resyncInterval _synced _unloadHandler _updateHandler awareness bcChannel bcconnected disableBc doc maxBackoffTime messageHandlers onFailureHandlers roomname shouldConnect url ws wsLastMessageReceived wsUnsuccessfulReconnects wsconnected wsconnecting

Accessors

synced

Methods

addOnFailureHandler connect connectBc destroy disconnect disconnectBc emit off on once

Constructors

constructor

  • new YSweetProvider(serverUrl, roomname, doc, opts?): YSweetProvider

  • Parameters

    • serverUrl: string

      server url

    • roomname: string

      room name

    • doc: Doc

      Y.Doc instance

    • Optional opts: YSweetProviderParams

      options

    Returns YSweetProvider

Properties

_WS

_WS: WebSocketPolyfillType

_awarenessUpdateHandler

_awarenessUpdateHandler: Function

_bcSubscriber

_bcSubscriber: Function

_checkInterval

_checkInterval: number | Timer

_observers

_observers: Map<string, any>

Some desc.

_resyncInterval

_resyncInterval: number | Timer

_synced

_synced: boolean

_unloadHandler

_unloadHandler: Function

_updateHandler

_updateHandler: ((arg0, arg1, arg2, arg3) => void)

Type declaration

    • (arg0, arg1, arg2, arg3): void

    • Parameters

      • arg0: Uint8Array
      • arg1: any
      • arg2: Doc
      • arg3: Transaction

      Returns void

awareness

awareness: Awareness

bcChannel

bcChannel: string

bcconnected

bcconnected: boolean

disableBc

disableBc: boolean

doc

doc: Doc

maxBackoffTime

maxBackoffTime: number

messageHandlers

messageHandlers: HandlerFunction[]

onFailureHandlers

onFailureHandlers: (() => void)[]

Type declaration

    • (): void

    • Returns void

roomname

roomname: string

shouldConnect

shouldConnect: boolean

url

url: string

ws

ws: null | WebSocket

wsLastMessageReceived

wsLastMessageReceived: number

wsUnsuccessfulReconnects

wsUnsuccessfulReconnects: number

wsconnected

wsconnected: boolean

wsconnecting

wsconnecting: boolean

Accessors

synced

  • get synced(): boolean

  • Returns boolean

  • set synced(state): void

  • Parameters

    • state: boolean

    Returns void

Methods

addOnFailureHandler

  • addOnFailureHandler(handler): (() => void)

  • Parameters

    • handler: (() => void)
        • (): void

        • Returns void

    Returns (() => void)

      • (): void

      • Returns void

connect

  • connect(): void

  • Returns void

connectBc

  • connectBc(): void

  • Returns void

destroy

  • destroy(): void

  • Returns void

disconnect

  • disconnect(): void

  • Returns void

disconnectBc

  • disconnectBc(): void

  • Returns void

emit

  • emit(name, args): void

  • Emit a named event. All registered event listeners that listen to the specified name will receive the event.

    Parameters

    • name: string

      The event name.

    • args: any[]

      The arguments that are applied to the event listener.

    Returns void

    Todo

    This should catch exceptions

off

  • off(name, f): void

  • Parameters

    • name: string
    • f: Function

    Returns void

on

  • on(name, f): void

  • Parameters

    • name: string
    • f: Function

    Returns void

once

  • once(name, f): void

  • Parameters

    • name: string
    • f: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_WS_awarenessUpdateHandler_bcSubscriber_checkInterval_observers_resyncInterval_synced_unloadHandler_updateHandlerawarenessbcChannelbcconnecteddisableBcdocmaxBackoffTimemessageHandlersonFailureHandlersroomnameshouldConnecturlwswsLastMessageReceivedwsUnsuccessfulReconnectswsconnectedwsconnectingsyncedaddOnFailureHandlerconnectconnectBcdestroydisconnectdisconnectBcemitoffononce