yonote/yjs
23
0
Fork 0
Code Pull Requests 1 Releases Activity

export V1 ⇔ V2 update format conversion. Closes #363

Browse Source
This commit is contained in:
Kevin Jahns 2021-12-15 18:45:08 +01:00
parent 9569d3e297
commit 1cf709093c
2 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -131,7 +131,9 @@ network provider.
</dd> </dd>
<dt><a href="https://github.com/marcopolo/y-libp2p">y-libp2p</a></dt> <dt><a href="https://github.com/marcopolo/y-libp2p">y-libp2p</a></dt>
<dd> <dd>
Uses <a href="https://libp2p.io/">libp2p</a> to propagate updates via <a href="https://github.com/libp2p/specs/tree/master/pubsub/gossipsub">GossipSub</a>. Also includes a peer-sync mechanism to catch up on missed updates. Uses <a href="https://libp2p.io/">libp2p</a> to propagate updates via
<a href="https://github.com/libp2p/specs/tree/master/pubsub/gossipsub">GossipSub</a>.
Also includes a peer-sync mechanism to catch up on missed updates.
</dd> </dd>
<dt><a href="https://github.com/yjs/y-dat">y-dat</a></dt> <dt><a href="https://github.com/yjs/y-dat">y-dat</a></dt>
<dd> <dd>
@ -717,7 +719,7 @@ Y.applyUpdate(ydoc1, diff2)
Y.applyUpdate(ydoc2, diff1) Y.applyUpdate(ydoc2, diff1)
``` ```
### Example: Syncing clients without loading the Y.Doc #### Example: Syncing clients without loading the Y.Doc
It is possible to sync clients and compute delta updates without loading the Yjs It is possible to sync clients and compute delta updates without loading the Yjs
document to memory. Yjs exposes an API to compute the differences directly on the document to memory. Yjs exposes an API to compute the differences directly on the
@ -741,6 +743,17 @@ currentState1 = Y.mergeUpdates([currentState1, diff2])
currentState1 = Y.mergeUpdates([currentState1, diff1]) currentState1 = Y.mergeUpdates([currentState1, diff1])
``` ```
#### Using V2 update format
Yjs implements two update formats. By default you are using the V1 update format.
You can opt-in into the V2 update format wich provides much better compression.
It is not yet used by all providers. However, you can already use it if
you are building your own provider. All below functions are available with the
suffix "V2". E.g. `Y.applyUpdate` ⇒ `Y.applyUpdateV2`. We also support conversion
functions between both formats: `Y.convertUpdateFormatV1ToV2` & `Y.convertUpdateFormatV2ToV1`.
#### Update API
<dl> <dl>
<b><code>Y.applyUpdate(Y.Doc, update:Uint8Array, [transactionOrigin:any])</code></b> <b><code>Y.applyUpdate(Y.Doc, update:Uint8Array, [transactionOrigin:any])</code></b>
<dd> <dd>
@ -773,6 +786,14 @@ Encode the missing differences to another update message. This function works
similarly to <code>Y.encodeStateAsUpdate(ydoc, stateVector)</code> but works similarly to <code>Y.encodeStateAsUpdate(ydoc, stateVector)</code> but works
on updates instead. on updates instead.
</dd> </dd>
<b><code>convertUpdateFormatV1ToV2</code></b>
<dd>
Convert V1 update format to the V2 update format.
</dd>
<b><code>convertUpdateFormatV2ToV1</code></b>
<dd>
Convert V2 update format to the V1 update format.
</dd>
</dl> </dl>
### Relative Positions ### Relative Positions

6
src/index.js
View File

@ -85,12 +85,16 @@ export {
encodeRelativePosition, encodeRelativePosition,
decodeRelativePosition, decodeRelativePosition,
diffUpdate, diffUpdate,
diffUpdateV2 diffUpdateV2,
convertUpdateFormatV1ToV2,
convertUpdateFormatV2ToV1
} from './internals.js' } from './internals.js'
const glo = /** @type {any} */ (typeof window !== 'undefined' const glo = /** @type {any} */ (typeof window !== 'undefined'
? window ? window
// @ts-ignore
: typeof global !== 'undefined' ? global : {}) : typeof global !== 'undefined' ? global : {})
const importIdentifier = '__ $YJS$ __' const importIdentifier = '__ $YJS$ __'
if (glo[importIdentifier] === true) { if (glo[importIdentifier] === true) {