Properties
_WS
_WS: { CLOSED: number ; CLOSING: number ; CONNECTING: number ; OPEN: number ; prototype: WebSocket }
Type declaration
Readonly CLOSED: number
Readonly CLOSING: number
Readonly CONNECTING: number
Readonly OPEN: number
prototype: WebSocket
_awarenessUpdateHandler
_awarenessUpdateHandler: ( __namedParameters: any , origin: any ) => void
Type declaration
( __namedParameters: any , origin: any ) : void
Parameters
__namedParameters: any
origin: any
Returns void
_bcSubscriber
_bcSubscriber: ( data: ArrayBuffer ) => void
Type declaration
( data: ArrayBuffer ) : void
_beforeUnloadHandler
_beforeUnloadHandler: ( ) => void
_checkInterval
_checkInterval: any
Private _contentType
_contentType: any
Defined in packages/docprovider/lib/yprovider.d.ts:53
Private _currentLockRequest
_currentLockRequest: any
Defined in packages/docprovider/lib/yprovider.d.ts:57
Private _initialContentRequest
_initialContentRequest: any
Defined in packages/docprovider/lib/yprovider.d.ts:58
Private _isInitialized
_isInitialized: any
Defined in packages/docprovider/lib/yprovider.d.ts:55
_observers
_observers: Map < string , any >
Private _onConnectionStatus
_onConnectionStatus: any
Defined in packages/docprovider/lib/yprovider.d.ts:51
Private _path
_path: any
Defined in packages/docprovider/lib/yprovider.d.ts:52
Private _requestLockInterval
_requestLockInterval: any
Defined in packages/docprovider/lib/yprovider.d.ts:56
_resyncInterval
_resyncInterval: number
Private _sendMessage
_sendMessage: any
Defined in packages/docprovider/lib/yprovider.d.ts:45
Private _serverUrl
_serverUrl: any
Defined in packages/docprovider/lib/yprovider.d.ts:54
_updateHandler
_updateHandler: ( update: Uint8Array , origin: any ) => void
Type declaration
( update: Uint8Array , origin: any ) : void
Parameters
update: Uint8Array
origin: any
Returns void
awareness
awareness: Awareness
bcChannel
bcChannel: string
bcconnected
bcconnected: boolean
messageHandlers
messageHandlers: ( ( arg0: Encoder , arg1: Decoder , arg2: WebsocketProvider , arg3: boolean , arg4: number ) => void ) []
roomname
roomname: string
shouldConnect
shouldConnect: boolean
wsLastMessageReceived
wsLastMessageReceived: number
wsUnsuccessfulReconnects
wsUnsuccessfulReconnects: number
wsconnected
wsconnected: boolean
wsconnecting
wsconnecting: boolean
A class to provide Yjs synchronization over WebSocket.
The user can specify their own user-name and user-color by adding url parameters: ?username=Alice&usercolor=007007 where usercolor must be a six-digit hexadecimal encoded RGB value without the hash token.
We specify custom messages that the server can interpret. For reference please look in yjs_ws_server.