From c80f446b5fbaaf1366dbd1c943ab238f3a8e3297 Mon Sep 17 00:00:00 2001 From: Kevin Jahns Date: Sun, 12 May 2019 11:18:43 +0200 Subject: [PATCH] README: update provider tutorial --- README.v13.md | 8 +++++--- src/structs/AbstractItem.js | 4 ++-- src/types/AbstractType.js | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.v13.md b/README.v13.md index 60cf3d21..0298cbb5 100644 --- a/README.v13.md +++ b/README.v13.md @@ -83,8 +83,10 @@ import * as Y from 'yjs' import { WebsocketProvider } from 'y-websocket' import { TextareaBinding } from 'y-textarea' -const provider = new WebsocketProvider('http://localhost:1234') -const doc = provider.get('roomname') +const doc = Y.Doc() +const provider = new WebsocketProvider('http://localhost:1234', 'roomname') +// sync all document updates through the websocket connection +provider.sync('doc') // Define a shared type on the document. const ytext = doc.getText('my resume') @@ -433,7 +435,7 @@ doc1.getArray('myarray').insert(0, ['Hello doc2, you got this?']) doc2.getArray('myarray').get(0) // => 'Hello doc2, you got this?' ``` -Yjs internally maintains a [State Vector](#State-Vector) that denotes the next expected clock from each client. In a different interpretation it holds the number of structs created by each client. When two clients sync, you can either exchange the complete document structure or only the differences by sending the state vector to compute the differences. +Yjs internally maintains a [state vector](#State-Vector) that denotes the next expected clock from each client. In a different interpretation it holds the number of structs created by each client. When two clients sync, you can either exchange the complete document structure or only the differences by sending the state vector to compute the differences. **Example: Sync two clients by exchanging the complete document structure** diff --git a/src/structs/AbstractItem.js b/src/structs/AbstractItem.js index 16a3d8ea..e28ce546 100644 --- a/src/structs/AbstractItem.js +++ b/src/structs/AbstractItem.js @@ -285,7 +285,7 @@ export class AbstractItem extends AbstractStruct { * @private */ copy (id, left, origin, right, rightOrigin, parent, parentSub) { - throw new Error('unimplemented') + throw error.methodUnimplemented() } /** @@ -393,7 +393,7 @@ export class AbstractItem extends AbstractStruct { * @private */ splitAt (transaction, diff) { - throw new Error('unimplemented') + throw error.methodUnimplemented() } /** diff --git a/src/types/AbstractType.js b/src/types/AbstractType.js index ae3f1e33..c0ad077f 100644 --- a/src/types/AbstractType.js +++ b/src/types/AbstractType.js @@ -101,7 +101,7 @@ export class AbstractType { * @private */ _copy () { - throw new Error('unimplemented') + throw error.methodUnimplemented() } /**