v7.0.1

Author: jamesgpearce

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/persister-automerge/"><code>persister-automerge</code></a></li><li><a href="/api/persister-automerge/interfaces/">Interfaces</a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/"><code>AutomergePersister</code></a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/">Listener methods</a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/"><code>addStatusListener</code></a></li></ul></nav><section class="s1" id="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/" data-id="aSL2"><h1><code>addStatusListener</code></h1><p>The <code>addStatusListener</code> method registers a listener function with the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be called whenever it starts or stops loading or saving.</p><pre><code><span class="function"><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/">addStatusListener</a></span><span class="punctuation">(</span>listener<span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span>StoreOnly<span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">string</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>listener</code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span>StoreOnly<span class="operator">></span></code></td><td><p>The function that will be called whenever the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> starts or stops loading or saving.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">string</span></code></td><td><p></p><p>A unique <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> for the listener that can later be used to remove it.</p><p></p></td></tr></table></div><p>The provided listener is a <a href="/api/persisters/type-aliases/listener/statuslistener/"><code>StatusListener</code></a> function, and will be called with a reference to the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> and the new <a href="/api/persisters/enumerations/lifecycle/status/"><code>Status</code></a>: 0 means now idle, 1 means now loading, and 2 means now saving.</p><section class="s2"><h2>Example</h2><p>This example registers a listener that responds to changes in the state of the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/persister-automerge/"><code>persister-automerge</code></a></li><li><a href="/api/persister-automerge/interfaces/">Interfaces</a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/"><code>AutomergePersister</code></a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/">Listener methods</a></li><li><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/"><code>addStatusListener</code></a></li></ul></nav><section class="s1" id="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/" data-id="aSL2"><h1><code>addStatusListener</code></h1><p>The <code>addStatusListener</code> method registers a listener function with the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be called whenever it starts or stops loading or saving.</p><pre><code><span class="function"><a href="/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/">addStatusListener</a></span><span class="punctuation">(</span>listener<span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span><span class="type"><a href="/api/persister-automerge/interfaces/persister/automergepersister/">AutomergePersister</a></span><span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">string</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>listener</code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span><span class="type"><a href="/api/persister-automerge/interfaces/persister/automergepersister/">AutomergePersister</a></span><span class="operator">></span></code></td><td><p>The function that will be called whenever the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> starts or stops loading or saving.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">string</span></code></td><td><p></p><p>A unique <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> for the listener that can later be used to remove it.</p><p></p></td></tr></table></div><p>The provided listener is a <a href="/api/persisters/type-aliases/listener/statuslistener/"><code>StatusListener</code></a> function, and will be called with a reference to the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> and the new <a href="/api/persisters/enumerations/lifecycle/status/"><code>Status</code></a>: 0 means now idle, 1 means now loading, and 2 means now saving.</p><section class="s2"><h2>Example</h2><p>This example registers a listener that responds to changes in the state of the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
 <span class="keyword">import</span> <span class="punctuation">{</span>createSessionPersister<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase/persisters/persister-browser'</span><span class="punctuation">;</span>
 
 <span class="keyword">const</span> persister <span class="operator">=</span> <span class="function"><a href="/api/the-essentials/persisting-stores/createsessionpersister/">createSessionPersister</a></span><span class="punctuation">(</span><span class="function"><a href="/api/the-essentials/creating-stores/createstore/">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">,</span> <span class="string">'pets'</span><span class="punctuation">)</span><span class="punctuation">;</span>

docs/api/persister-automerge/interfaces/persister/automergepersister/methods/listener/addstatuslistener/article.html

@@ -1,4 +1,4 @@
-<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/persister-browser/"><code>persister-browser</code></a></li><li><a href="/api/persister-browser/interfaces/">Interfaces</a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/"><code>LocalPersister</code></a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/">Listener methods</a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/"><code>addStatusListener</code></a></li></ul></nav><section class="s1" id="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/" data-id="aSL3"><h1><code>addStatusListener</code></h1><p>The <code>addStatusListener</code> method registers a listener function with the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be called whenever it starts or stops loading or saving.</p><pre><code><span class="function"><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/">addStatusListener</a></span><span class="punctuation">(</span>listener<span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span>StoreOrMergeableStore<span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">string</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>listener</code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span>StoreOrMergeableStore<span class="operator">></span></code></td><td><p>The function that will be called whenever the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> starts or stops loading or saving.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">string</span></code></td><td><p></p><p>A unique <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> for the listener that can later be used to remove it.</p><p></p></td></tr></table></div><p>The provided listener is a <a href="/api/persisters/type-aliases/listener/statuslistener/"><code>StatusListener</code></a> function, and will be called with a reference to the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> and the new <a href="/api/persisters/enumerations/lifecycle/status/"><code>Status</code></a>: 0 means now idle, 1 means now loading, and 2 means now saving.</p><section class="s2"><h2>Example</h2><p>This example registers a listener that responds to changes in the state of the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/persister-browser/"><code>persister-browser</code></a></li><li><a href="/api/persister-browser/interfaces/">Interfaces</a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/"><code>LocalPersister</code></a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/">Listener methods</a></li><li><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/"><code>addStatusListener</code></a></li></ul></nav><section class="s1" id="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/" data-id="aSL3"><h1><code>addStatusListener</code></h1><p>The <code>addStatusListener</code> method registers a listener function with the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> that will be called whenever it starts or stops loading or saving.</p><pre><code><span class="function"><a href="/api/persister-browser/interfaces/persister/localpersister/methods/listener/addstatuslistener/">addStatusListener</a></span><span class="punctuation">(</span>listener<span class="operator">:</span> <span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span><span class="type"><a href="/api/persister-browser/interfaces/persister/localpersister/">LocalPersister</a></span><span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="builtin">string</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>listener</code></th><td><code><span class="type"><a href="/api/persisters/type-aliases/listener/statuslistener/">StatusListener</a></span><span class="operator">&lt;</span><span class="type"><a href="/api/persister-browser/interfaces/persister/localpersister/">LocalPersister</a></span><span class="operator">></span></code></td><td><p>The function that will be called whenever the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> starts or stops loading or saving.</p></td></tr><tr><th class="right">returns</th><td><code><span class="builtin">string</span></code></td><td><p></p><p>A unique <a href="/api/common/type-aliases/identity/id/"><code>Id</code></a> for the listener that can later be used to remove it.</p><p></p></td></tr></table></div><p>The provided listener is a <a href="/api/persisters/type-aliases/listener/statuslistener/"><code>StatusListener</code></a> function, and will be called with a reference to the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a> and the new <a href="/api/persisters/enumerations/lifecycle/status/"><code>Status</code></a>: 0 means now idle, 1 means now loading, and 2 means now saving.</p><section class="s2"><h2>Example</h2><p>This example registers a listener that responds to changes in the state of the <a href="/api/persisters/interfaces/persister/persister/"><code>Persister</code></a>.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
 <span class="keyword">import</span> <span class="punctuation">{</span>createSessionPersister<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase/persisters/persister-browser'</span><span class="punctuation">;</span>
 
 <span class="keyword">const</span> persister <span class="operator">=</span> <span class="function"><a href="/api/the-essentials/persisting-stores/createsessionpersister/">createSessionPersister</a></span><span class="punctuation">(</span><span class="function"><a href="/api/the-essentials/creating-stores/createstore/">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">,</span> <span class="string">'pets'</span><span class="punctuation">)</span><span class="punctuation">;</span>