v6.1.2

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":7083,"assertions":32844,"lines":{"total":2308,"covered":2308,"skipped":0,"pct":100},"statements":{"total":2494,"covered":2494,"skipped":0,"pct":100},"functions":{"total":997,"covered":997,"skipped":0,"pct":100},"branches":{"total":876,"covered":876,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{"tests":7082,"assertions":32840,"lines":{"total":2308,"covered":2308,"skipped":0,"pct":100},"statements":{"total":2494,"covered":2494,"skipped":0,"pct":100},"functions":{"total":997,"covered":997,"skipped":0,"pct":100},"branches":{"total":876,"covered":876,"skipped":0,"pct":100},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}

docs/api/all.html

@@ -1,4 +1,4 @@
 <nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/persisters/"><code>persisters</code></a></li><li><a href="/api/persisters/type-aliases/">Type Aliases</a></li><li><a href="/api/persisters/type-aliases/creation/">Creation type aliases</a></li><li><a href="/api/persisters/type-aliases/creation/persisterlistener/"><code>PersisterListener</code></a></li></ul></nav><section class="s1" id="/api/persisters/type-aliases/creation/persisterlistener/" data-id="PL"><h1><code>PersisterListener</code></h1><p>A <code>PersisterListener</code> is a generic representation of the callback that lets a <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> inform the store that a change has happened to the underlying data.</p><pre><code><span class="punctuation">(</span>
   content<span class="operator">?</span><span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedcontent/">PersistedContent</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span><span class="punctuation">,</span>
   changes<span class="operator">?</span><span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedchanges/">PersistedChanges</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span><span class="punctuation">,</span>
-<span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>content<span class="operator">?</span></code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedcontent/">PersistedContent</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span></code></td><td><p>If provided, this is a <a href="/api/store/type-aliases/store/content/"><code>Content</code></a> object from the the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be used to immediately wholesale update the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>.</p></td></tr><tr><th><code>changes<span class="operator">?</span></code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedchanges/">PersistedChanges</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span></code></td><td><p>If provided, this is a <a href="/api/store/type-aliases/transaction/changes/"><code>Changes</code></a> object from the the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be used to immediately incrementally update the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. This takes priority over the content argument above if present.</p></td></tr><tr><th class="right">returns</th><td><code><span class="keyword">void</span></code></td><td><p>This has no return value.</p></td></tr></table></div><p>Using the values of the <a href="/api/persisters/enumerations/mergeable/persists/"><code>Persists</code></a> enum, the generic parameter indicates whether the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> is handling content and changes from a regular <a href="/api/store/interfaces/store/store/"><code>Store</code></a>, a <a href="/api/mergeable-store/interfaces/mergeable/mergeablestore/"><code>MergeableStore</code></a>, or either.</p><p>If the listener is called with the <code>changes</code> parameter, it will be used to make an incremental change to the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. If not, but the <code>content</code> parameter is available, that will be used to make a wholesale change to the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. If neither are present, the content will be loaded using the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>&#x27;s <a href="/api/persisters/interfaces/persister/persister/methods/load/load/"><code>load</code></a> method. Prior to v5.0, these parameters were callbacks and the overall type was non-generic.</p><section class="s2"><h2>Since</h2><p>v4.0.0</p></section></section>
+<span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>content<span class="operator">?</span></code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedcontent/">PersistedContent</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span></code></td><td><p>If provided, this is a <a href="/api/store/type-aliases/store/content/"><code>Content</code></a> object from the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be used to immediately wholesale update the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>.</p></td></tr><tr><th><code>changes<span class="operator">?</span></code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/mergeable/persistedchanges/">PersistedChanges</a></span><span class="operator">&lt;</span>Persist<span class="operator">></span></code></td><td><p>If provided, this is a <a href="/api/store/type-aliases/transaction/changes/"><code>Changes</code></a> object from the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be used to immediately incrementally update the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. This takes priority over the content argument above if present.</p></td></tr><tr><th class="right">returns</th><td><code><span class="keyword">void</span></code></td><td><p>This has no return value.</p></td></tr></table></div><p>Using the values of the <a href="/api/persisters/enumerations/mergeable/persists/"><code>Persists</code></a> enum, the generic parameter indicates whether the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> is handling content and changes from a regular <a href="/api/store/interfaces/store/store/"><code>Store</code></a>, a <a href="/api/mergeable-store/interfaces/mergeable/mergeablestore/"><code>MergeableStore</code></a>, or either.</p><p>If the listener is called with the <code>changes</code> parameter, it will be used to make an incremental change to the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. If not, but the <code>content</code> parameter is available, that will be used to make a wholesale change to the <a href="/api/store/interfaces/store/store/"><code>Store</code></a>. If neither are present, the content will be loaded using the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>&#x27;s <a href="/api/persisters/interfaces/persister/persister/methods/load/load/"><code>load</code></a> method. Prior to v5.0, these parameters were callbacks and the overall type was non-generic.</p><section class="s2"><h2>Since</h2><p>v4.0.0</p></section></section>