You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/chapters/record.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -351,8 +351,6 @@ Recursively dispose the record and its aggregated members. "Dispose" means that
351
351
352
352
The whole aggregation tree will be recursively disposed, shared members won't.
353
353
354
-
All records and collections except [shared objects](04_Shared_objects.md) are serializable by default as nested JSON reflecting the structure of their aggregation tree.
<p>The state defined with Type-R classes is deeply observable and serializable by default. While being an advanced JSON serialization engine handling sophisticated scenarios (like cross-collections many-to-many relationships), Type-R is completely unopinionated on the client-server transport protocol.</p>
83
83
<p>Type-R is your perfect M and VM in MVVM and MVC architecture imposing no restrictions on V and C parts.</p>
84
+
<h2id="installation-and-requirements">Installation and requirements</h2>
85
+
<p>Is packed as UMD and ES6 module. No peer dependencies are required.</p>
86
+
<p><code>npm install type-r --save-dev</code></p>
87
+
<asideclass="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
88
+
89
+
<asideclass="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
90
+
84
91
<h2id="how-the-type-r-compares-with-x-">How the Type-R compares with X?</h2>
85
92
<p>Type-R started to develop in 2014 as the modern substitution for BackboneJS, which would retain the spirit of the BackboneJS simplicity but would be superior to Ember Data in its capabilities and an order of magnitude faster than Backbone.</p>
86
93
<p>The closest things to the Type-R are <ahref="https://guides.emberjs.com/v2.2.0/models/">Ember Data</a>, <ahref="http://backbonejs.org/#Model">BackboneJS models and collections</a>, and <ahref="https://github.com/mobxjs/mobx">mobx</a>. </p>
@@ -154,12 +161,6 @@ <h2 id="how-the-type-r-compares-with-x-">How the Type-R compares with X?</h2>
154
161
</tr>
155
162
</tbody>
156
163
</table>
157
-
<h2id="installation-and-requirements">Installation and requirements</h2>
158
-
<p>Is packed as UMD and ES6 module. No peer dependencies are required.</p>
159
-
<p><code>npm install type-r --save-dev</code></p>
160
-
<asideclass="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
161
-
162
-
<asideclass="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
163
164
164
165
<h1id="events">Events</h1>
165
166
<p>Type-R uses an efficient synchronous events implementation which is backward compatible with Backbone 1.1 Events API but is about twice faster in all major browsers. It comes in form of <code>Events</code> mixin and the <code>Messenger</code> base class.</p>
@@ -571,7 +572,6 @@ <h3 id="-callback-record-initialize-attrs-options-"><code>callback</code> record
571
572
<h3id="record-dispose-">record.dispose()</h3>
572
573
<p>Recursively dispose the record and its aggregated members. "Dispose" means that elements of the aggregation tree will unsubscribe from all event sources. It's crucial to prevent memory leaks in SPA.</p>
573
574
<p>The whole aggregation tree will be recursively disposed, shared members won't.</p>
574
-
<p>All records and collections except <ahref="04_Shared_objects.md">shared objects</a> are serializable by default as nested JSON reflecting the structure of their aggregation tree.</p>
575
575
<h2id="read-and-update">Read and Update</h2>
576
576
<h3id="record-cid">record.cid</h3>
577
577
<p>Read-only client-side record's identifier. Generated upon creation of the record and is unique for every record's instance. Cloned records will have different <code>cid</code>.</p>
Copy file name to clipboardExpand all lines: docs/index.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,16 @@ The state defined with Type-R classes is deeply observable and serializable by d
28
28
29
29
Type-R is your perfect M and VM in MVVM and MVC architecture imposing no restrictions on V and C parts.
30
30
31
+
## Installation and requirements
32
+
33
+
Is packed as UMD and ES6 module. No peer dependencies are required.
34
+
35
+
`npm install type-r --save-dev`
36
+
37
+
<asideclass="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
38
+
39
+
<asideclass="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
40
+
31
41
## How the Type-R compares with X?
32
42
33
43
Type-R started to develop in 2014 as the modern substitution for BackboneJS, which would retain the spirit of the BackboneJS simplicity but would be superior to Ember Data in its capabilities and an order of magnitude faster than Backbone.
@@ -57,13 +67,3 @@ Validation | ✓ | ✓ | ✓ | -
57
67
Dynamic Type Safety | ✓ | - | For serialization only | -
58
68
Aggregation | ✓ | - | - | -
59
69
Relations by id | ✓ | - | ✓ | -
60
-
61
-
## Installation and requirements
62
-
63
-
Is packed as UMD and ES6 module. No peer dependencies are required.
64
-
65
-
`npm install type-r --save-dev`
66
-
67
-
<asideclass="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
68
-
69
-
<asideclass="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
0 commit comments