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

Merge pull request #583 from nikgraf/improve-docs

Browse Source 
add documentation on V2 events
This commit is contained in:
Kevin Jahns 2023-11-14 20:30:04 +01:00 committed by GitHub
commit ac49dbcbd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -698,7 +698,8 @@ type. Doesn't log types that have not been defined (using
<b><code>on('update', function(updateMessage:Uint8Array, origin:any, Y.Doc):void)</code></b> <b><code>on('update', function(updateMessage:Uint8Array, origin:any, Y.Doc):void)</code></b>
<dd> <dd>
Listen to document updates. Document updates must be transmitted to all other Listen to document updates. Document updates must be transmitted to all other
peers. You can apply document updates in any order and multiple times. peers. You can apply document updates in any order and multiple times. Use `updateV2`
to receive V2 events.
</dd> </dd>
<b><code>on('beforeTransaction', function(Y.Transaction, Y.Doc):void)</code></b> <b><code>on('beforeTransaction', function(Y.Transaction, Y.Doc):void)</code></b>
<dd>Emitted before each transaction.</dd> <dd>Emitted before each transaction.</dd>
@ -823,8 +824,10 @@ 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. 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 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 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 suffix "V2". E.g. `Y.applyUpdate` ⇒ `Y.applyUpdateV2`. Also when listening to updates
functions between both formats: `Y.convertUpdateFormatV1ToV2` & `Y.convertUpdateFormatV2ToV1`. you need to specifically need listen for V2 events e.g. `yDoc.on('updateV2', …)`.
We also support conversion functions between both formats:
`Y.convertUpdateFormatV1ToV2` & `Y.convertUpdateFormatV2ToV1`.
#### Update API #### Update API