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

add gc information to API docs

Browse Source
This commit is contained in:
Kevin Jahns 2020-04-26 13:24:18 +02:00
parent 180f4667c1
commit b399ffa765
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -463,6 +463,12 @@ const doc = new Y.Doc()
<dl> <dl>
<b><code>clientID</code></b> <b><code>clientID</code></b>
<dd>A unique id that identifies this client. (readonly)</dd> <dd>A unique id that identifies this client. (readonly)</dd>
<b><code>gc</code></b>
<dd>
Whether garbage collection is enabled on this doc instance. Set `doc.gc = false`
in order to disable gc and be able to restore old content. See https://github.com/yjs/yjs#yjs-crdt-algorithm
for more information about gc in Yjs.
</dd>
<b><code>transact(function(Transaction):void [, origin:any])</code></b> <b><code>transact(function(Transaction):void [, origin:any])</code></b>
<dd> <dd>
Every change on the shared document happens in a transaction. Observer calls and Every change on the shared document happens in a transaction. Observer calls and
@ -712,7 +718,9 @@ UndoManager instance is always added to `trackedOrigins`.
class CustomBinding {} class CustomBinding {}
const ytext = doc.getArray('array') const ytext = doc.getArray('array')
const undoManager = new Y.UndoManager(ytext, { trackedOrigins: new Set([42, CustomBinding]) }) const undoManager = new Y.UndoManager(ytext, {
trackedOrigins: new Set([42, CustomBinding])
})
ytext.insert(0, 'abc') ytext.insert(0, 'abc')
undoManager.undo() undoManager.undo()
@ -750,7 +758,9 @@ document. You can assign meta-information to Undo-/Redo-StackItems.
```js ```js
const ytext = doc.getArray('array') const ytext = doc.getArray('array')
const undoManager = new Y.UndoManager(ytext, { trackedOrigins: new Set([42, CustomBinding]) }) const undoManager = new Y.UndoManager(ytext, {
trackedOrigins: new Set([42, CustomBinding])
})
undoManager.on('stack-item-added', event => { undoManager.on('stack-item-added', event => {
// save the current cursor location on the stack-item // save the current cursor location on the stack-item