Optional
extraOptions: Partial<YSweetProviderParams>Private
WebPrivate
_onPrivate
ackedPrivate
attemptPrivate
authAwareness protocol instance.
Private
bindPrivate
broadcastPrivate
checkPrivate
clearPrivate
clearCurrent client token.
Private
connectionPrivate
docPrivate
docPrivate
ensurePrivate
handlePrivate
heartbeatPrivate
incrementPrivate
indexedDBProviderPrivate
isWhether we are currently in the process of connecting.
Private
listenersPrivate
localPrivate
offlinePrivate
onlinePrivate
queryPrivate
receivePrivate
receivePrivate
receivedOlder versions of the Y-Sweet server did not support the sync message, and would ignore it. This may lead to the client thinking the server is offline, when really it just doesn't know how to return a heartbeat.
Eventually, we will build protocol version negotiation into the handshake. Until then, we use a simple approach: until we receive the first sync message back, we assume the server is an older version for the purpose of the heartbeat logic.
Private
reconnectPrivate
resetPrivate
retriesPrivate
sendPrivate
setPrivate
setConnection status.
Private
syncPrivate
updatePrivate
updatePrivate
updatePrivate
websocketPrivate
websocketPrivate
websocketPrivate
websocketWhether the document has local changes.
Whether the provider should attempt to connect.
use provider.status !== 'offline' instead, or call provider.connect()
/ provider.disconnect()
to set.
Whether the document is synced. (For compatibility with y-websocket.)
use provider.status === 'connected' instead.
Whether the underlying websocket is connected.
use provider.status === 'connected' || provider.status === 'handshaking' instead.
Whether the underlying websocket is connecting.
use provider.status === 'connecting' instead.
Attempts to connect to the websocket. Returns a promise that resolves to true if the connection was successful, or false if the connection failed.