Properties
_WS
_WS : WebSocketPolyfillType
Defined in ../client/dist/main.d.ts:54
_awarenessUpdateHandler
_awarenessUpdateHandler : Function
Defined in ../client/dist/main.d.ts:69
_bcSubscriber
_bcSubscriber : Function
Defined in ../client/dist/main.d.ts:67
_checkInterval
_checkInterval : number | Timer
Defined in ../client/dist/main.d.ts:71
_observers
_observers : Map < string , any >
_resyncInterval
_resyncInterval : number | Timer
Defined in ../client/dist/main.d.ts:66
_synced
_synced : boolean
Defined in ../client/dist/main.d.ts:62
_unloadHandler
_unloadHandler : Function
Defined in ../client/dist/main.d.ts:70
_updateHandler
_updateHandler : Function
Defined in ../client/dist/main.d.ts:68
awareness
awareness : Awareness
Defined in ../client/dist/main.d.ts:55
bcChannel
bcChannel : string
Defined in ../client/dist/main.d.ts:50
bcconnected
bcconnected : boolean
Defined in ../client/dist/main.d.ts:58
disableBc
disableBc : boolean
Defined in ../client/dist/main.d.ts:59
doc
doc : Doc
Defined in ../client/dist/main.d.ts:53
maxBackoffTime
maxBackoffTime : number
Defined in ../client/dist/main.d.ts:49
messageHandlers
messageHandlers : HandlerFunction []
Defined in ../client/dist/main.d.ts:61
roomname
roomname : string
Defined in ../client/dist/main.d.ts:52
shouldConnect
shouldConnect : boolean
Defined in ../client/dist/main.d.ts:65
url
url : string
Defined in ../client/dist/main.d.ts:51
ws
ws : null | WebSocket
Defined in ../client/dist/main.d.ts:63
wsLastMessageReceived
wsLastMessageReceived : number
Defined in ../client/dist/main.d.ts:64
wsUnsuccessfulReconnects
wsUnsuccessfulReconnects : number
Defined in ../client/dist/main.d.ts:60
wsconnected
wsconnected : boolean
Defined in ../client/dist/main.d.ts:56
wsconnecting
wsconnecting : boolean
Defined in ../client/dist/main.d.ts:57
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