Skip to content

Commit 93a6e5a

Browse files
author
Vlad Balin
committed
docs
1 parent 771216e commit 93a6e5a

File tree

3 files changed

+17
-19
lines changed

3 files changed

+17
-19
lines changed

docs/chapters/record.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,8 +351,6 @@ Recursively dispose the record and its aggregated members. "Dispose" means that
351351
352352
The whole aggregation tree will be recursively disposed, shared members won't.
353353
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.
355-
356354
## Read and Update
357355
358356
### record.cid

docs/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,13 @@ <h1 id="getting-started">Getting started</h1>
8181
</ul>
8282
<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>
8383
<p>Type-R is your perfect M and VM in MVVM and MVC architecture imposing no restrictions on V and C parts.</p>
84+
<h2 id="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+
<aside class="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
88+
89+
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
90+
8491
<h2 id="how-the-type-r-compares-with-x-">How the Type-R compares with X?</h2>
8592
<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>
8693
<p>The closest things to the Type-R are <a href="https://guides.emberjs.com/v2.2.0/models/">Ember Data</a>, <a href="http://backbonejs.org/#Model">BackboneJS models and collections</a>, and <a href="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>
154161
</tr>
155162
</tbody>
156163
</table>
157-
<h2 id="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-
<aside class="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
161-
162-
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
163164

164165
<h1 id="events">Events</h1>
165166
<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
571572
<h3 id="record-dispose-">record.dispose()</h3>
572573
<p>Recursively dispose the record and its aggregated members. &quot;Dispose&quot; means that elements of the aggregation tree will unsubscribe from all event sources. It&#39;s crucial to prevent memory leaks in SPA.</p>
573574
<p>The whole aggregation tree will be recursively disposed, shared members won&#39;t.</p>
574-
<p>All records and collections except <a href="04_Shared_objects.md">shared objects</a> are serializable by default as nested JSON reflecting the structure of their aggregation tree.</p>
575575
<h2 id="read-and-update">Read and Update</h2>
576576
<h3 id="record-cid">record.cid</h3>
577577
<p>Read-only client-side record&#39;s identifier. Generated upon creation of the record and is unique for every record&#39;s instance. Cloned records will have different <code>cid</code>.</p>

docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ The state defined with Type-R classes is deeply observable and serializable by d
2828

2929
Type-R is your perfect M and VM in MVVM and MVC architecture imposing no restrictions on V and C parts.
3030

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+
<aside class="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
38+
39+
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
40+
3141
## How the Type-R compares with X?
3242

3343
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 | ✓ | ✓ | ✓ | -
5767
Dynamic Type Safety | ✓ | - | For serialization only | -
5868
Aggregation | ✓ | - | - | -
5969
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-
<aside class="success">IE10+, Edge, Safari, Chrome, and Firefox are supported</aside>
68-
69-
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>

0 commit comments

Comments
 (0)