Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebSocketProvider

A class to provide Yjs synchronization over WebSocket.

We specify custom messages that the server can interpret. For reference please look in yjs_ws_server.

Hierarchy

  • WebSocketProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new WebSocketProvider

    Parameters

    • options: IOptions

      The instantiation options for a WebSocketProvider

    Returns WebSocketProvider

Properties

Private _awareness

_awareness: any

Private _contentType

_contentType: any

Private _format

_format: any

Private _isDisposed

_isDisposed: any

Private _onConnectionClosed

_onConnectionClosed: any

Private _onUserChanged

_onUserChanged: any

Private _path

_path: any

Private _ready

_ready: any

Private _serverUrl

_serverUrl: any

Private _sharedModel

_sharedModel: any

Private _trans

_trans: any

Private _yWebsocketProvider

_yWebsocketProvider: any

Accessors

isDisposed

  • get isDisposed(): boolean

  • Test whether the object has been disposed.

    Returns boolean

ready

  • get ready(): Promise<void>

  • A promise that resolves when the document provider is ready.

    Returns Promise<void>

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Returns void

Generated using TypeDoc