Browse files

Document `store.unregister`

  • Loading branch information...
1 parent 4113c69 commit 07258b9159f85f1d246194c82c9e794dc1980447 @PaulUithol committed Feb 3, 2014
Showing with 14 additions and 1 deletion.
  1. +14 −1 index.html
15 index.html
@@ -1065,7 +1065,7 @@ <h2 >Backbone.Store</h2>
<h4 class="code" id="Store-addModelScope">
- addModelScope<code> scope&lt;object&gt; )</code>
+ addModelScope<code>;object&gt;)</code>
Add a namespace on which models and collections are defined. This is especially useful when working in an
@@ -1088,6 +1088,15 @@ <h4 class="code" id="Store-reset">
Reset the <q>store</q> to it's original state. This will disable relations for all models created up to this point,
remove added model scopes, and removed all internal store collections.
+ <h4 class="code" id="Store-unregister">
+ unregister<code>;Backbone.RelationalModel|Backbone.RelationalModel.constructor|Backbone.Collection&gt;)</code>
+ </h4>
+ <p>
+ Unregister a single model or a collection. Unregistering a model will remove a model from any relations it's involved in.
+ Internally, unregister is called when a model has been destroyed. It can also be called explicitly to on models
+ you don't want Backbone-relational to consider for relations anymore, for example to free up models used as (temporary) search results.
+ </p>
<section id="examples">
@@ -1238,6 +1247,10 @@ <h2 >Examples</h2>
<a href=""><q>#419</q></a>:
Proper return values for single models on collection methods for Backbone 1.1.0
+ <li>
+ <a href=""><q>4113c69</q></a>
+ `` now also acceps collections or a model type
+ </li>

0 comments on commit 07258b9

Please sign in to comment.