Project y-webxdc
Type Aliases§
- Payload
The status-update payload exchanged between peers.
- WebxdcTransport
The subset of
Webxdcthis provider uses. Pass your fullwindow.webxdchere.
Variables§
- awarenessItemCodec
This codec encodes Webxdc awareness entries (as a webxdc update).
- updateItemCodec
This codec encodes Webxdc update log entries.
Functions§
- incrementalProtocol
Send only what changed to the local yjs document on every webxdc autosave tick.
- realtimeProtocol
A protocol with a realtime accelerator channel.
- sendAllProtocol
Sends the whole document state on every webxdc autosave tick.
- sendAllWithAwarenessProtocol
A protocol that also sends awareness information with the webxdc update.
Classes§
- AwarenessStrategy
Convenience base class for strategies.
- BaseStrategy
Convenience base class for strategies.
- IncrementalStrategy
Send only the data of each local edit.
- OutgoingBuffer
An outgoing buffer that stages items until the next flush.
- Protocol
The protocol the provider runs.
- SendAllStrategy
Send the entire document state whenever there was a local edit.
- WebxdcProvider
Webxdc integration with yjs.
Interfaces§
- AwarenessItem
Items sent between peers can be distinguished by type.
- EditInfo
Display metadata for an edit, shown in the chat.
- Item
Items sent between peers can be distinguished by type.
- SyncContext
Content the strategy acts on.
- SyncStrategy
A sync strategy that handles a single item type: handle incoming items, determine what items to send.
- UpdateItem
An update item carries yjs update data for the receiver to apply.
- WebxdcProviderOptions
Configuration for WebxdcProvider.
- WebxdcUpdateItemCodec
The webxdc update log wants JSON.