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

fixes issue #1 and #2

Browse Source
This commit is contained in:
Kevin Jahns
2014-08-21 04:19:55 +02:00
parent 465a2f18e6
commit ad5898a77a
29 changed files with 323 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
examples/PeerJs-Json/README.md
View File

@@ -125,6 +125,29 @@ Lists are always immutable.
```
### Check Types
Certainly you want to check types!
Here, we create a function that parses an Yatta type to a string.
You find all the types that Yatta provides in `yatta.types`.
```js
function show(o){
var t = yatta.types
if (o instanceof t.JsonType){
return JSON.stringify(o.toJson());
} else if (o instanceof t.Word) {
return o.val();
} else if (o.constructor === {}.constructor) { // It's an Object
return JSON.stringify(o);
} else { // It's a primitive data type (E.g. string, int)
return o;
}
}
```
### Add listeners
Apply a 'addProperty' - listener to a JsonType.
@@ -132,6 +155,7 @@ Apply a 'addProperty' - listener to a JsonType.
```js
function addProperty(event_name, property_name){
console.log("Property '" + property_name + "' was created!");
console.log("Value: " + show(this.val(property_name))); // 'this' is the object on which the property was created.
};
yatta.on('addProperty', addProperty);
yatta.val('new', {z: 7}); // Property 'new' was created!
@@ -143,19 +167,20 @@ Apply a 'change' - listener to a JsonType.
```js
function change(event_name, property_name){
console.log("Property '" + property_name + "' was replaced or changed!");
console.log("New value: \"" + this.val(property_name).val() + "\""); // 'this' is the new/created value
console.log("Value of property '" + property_name + "' changed!");
console.log("New value: " + show(this.val(property_name)) + ""); // 'this' is the object on which the property changed.
};
yatta.on('change', change);
yatta.val('mutable_string', "text", 'mutable'); // Property 'mutable_string' was replaced or changed!
```
Does not fire for nested properties.
'change' and 'addProperty' do also fire for nested properties.
```js
yatta.val('new').val('z', 8); // No output!
yatta.val('new').val('z', {'replace' : "x"}); // Property 'z' was replaced or changed!
yatta.val('new').val('z').val('new', {"true": true}); // Property 'z' was replaced or changed! + Property 'new' was created!
```

4
examples/PeerJs-Json/index.html
View File

@@ -10,12 +10,12 @@
</head>
<body>
<h1> Text Editing Demo</h1>
<p> Collaborative text editing with <a href="https://github.com/DadaMonad/Yatta/">Yatta</a>
<p> Collaborative Json editing with <a href="https://github.com/DadaMonad/Yatta/">Yatta</a>
and <a href="http://peerjs.com/">PeerJs</a> (WebRTC). </p>
<p> <a href="https://github.com/DadaMonad/Yatta/">Yatta</a> is a Framework for Real-Time collaboration on arbitrary data structures.
You can find the code for this example <a href="https://github.com/DadaMonad/Yatta/tree/master/examples/TextEditing">here</a>.
You can find the code for this example <a href="https://github.com/DadaMonad/Yatta/tree/master/examples/PeerJs-Json">here</a>.
</p>
</body>
</html>

30
examples/PeerJs-Json/index.js
View File

@@ -94,12 +94,33 @@ You can also specify your own user_id with peerjs. But you have to make sure tha
yatta.val('list', [1,2,3]);
console.log(yatta.val('list')[2] === 3); // true
/**
### Check Types
Certainly you want to check types!
Here, we create a function that parses an Yatta type to a string.
You find all the types that Yatta provides in `yatta.types`.
*/
function show(o){
var t = yatta.types
if (o instanceof t.JsonType){
return JSON.stringify(o.toJson());
} else if (o instanceof t.Word) {
return o.val();
} else if (o.constructor === {}.constructor) { // It's an Object
return JSON.stringify(o);
} else { // It's a primitive data type (E.g. string, int)
return o;
}
}
/**
### Add listeners
Apply a 'addProperty' - listener to a JsonType.
*/
function addProperty(event_name, property_name){
console.log("Property '" + property_name + "' was created!");
console.log("Value: " + show(this.val(property_name))); // 'this' is the object on which the property was created.
};
yatta.on('addProperty', addProperty);
yatta.val('new', {z: 7}); // Property 'new' was created!
@@ -108,16 +129,17 @@ You can also specify your own user_id with peerjs. But you have to make sure tha
Apply a 'change' - listener to a JsonType.
*/
function change(event_name, property_name){
console.log("Property '" + property_name + "' was replaced or changed!");
console.log("New value: \"" + this.val(property_name).val() + "\""); // 'this' is the new/created value
console.log("Value of property '" + property_name + "' changed!");
console.log("New value: " + show(this.val(property_name)) + ""); // 'this' is the object on which the property changed.
};
yatta.on('change', change);
yatta.val('mutable_string', "text", 'mutable'); // Property 'mutable_string' was replaced or changed!
/**
Does not fire for nested properties.
'change' and 'addProperty' do also fire for nested properties.
*/
yatta.val('new').val('z', 8); // No output!
yatta.val('new').val('z', {'replace' : "x"}); // Property 'z' was replaced or changed!
yatta.val('new').val('z').val('new', {"true": true}); // Property 'z' was replaced or changed! + Property 'new' was created!
/**
Apply 'insert' and 'delete' - listeners to Words.