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

Merge pull request #224 from ajhyndman/document-tojson

Browse Source 
Document the  doc.toJSON method
This commit is contained in:
Kevin Jahns 2020-08-04 16:53:10 +02:00 committed by GitHub
commit 7876a96163
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -571,6 +571,8 @@ triggers a single change event. <br>You can specify an optional <code>origin</co
parameter that is stored on <code>transaction.origin</code> and
<code>on('update', (update, origin) => ..)</code>.
</dd>
<b><code>toJSON():any</code><b>
<dd>Converts the entire document into a js object, recursively traversing each yjs type.</dd>
<b><code>get(string, Y.[TypeClass]):[Type]</code></b>
<dd>Define a shared type.</dd>
<b><code>getArray(string):Y.Array</code></b>