v4.6.3

Author: jamesgpearce

docs/api/all.html

@@ -6672,7 +6672,7 @@
 <span class="keyword">await</span> persister<span class="punctuation">.</span><span class="function">save</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// Store will be saved to the document.</span>
 
-console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>docHandler<span class="punctuation">.</span>doc<span class="punctuation">)</span><span class="punctuation">;</span>
+console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span><span class="keyword">await</span> docHandler<span class="punctuation">.</span><span class="function">doc</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}</span>
 
 persister<span class="punctuation">.</span><span class="function">destroy</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
@@ -6681,7 +6681,7 @@
   <span class="literal-property">network</span><span class="operator">:</span> <span class="punctuation">[</span><span class="keyword">new</span> <span class="class-name">BroadcastChannelNetworkAdapter</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">]</span><span class="punctuation">,</span>
 <span class="punctuation">}</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> docHandler1 <span class="operator">=</span> repo1<span class="punctuation">.</span><span class="function">create</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
-<span class="keyword">await</span> docHandler1<span class="punctuation">.</span><span class="function">value</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="keyword">await</span> docHandler1<span class="punctuation">.</span><span class="function">doc</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> store1 <span class="operator">=</span> <span class="function"><a href="#/api/store/functions/creation/createstore/">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> persister1 <span class="operator">=</span> <span class="function"><a href="#/api/persister-automerge/functions/creation/createautomergepersister/">createAutomergePersister</a></span><span class="punctuation">(</span>store1<span class="punctuation">,</span> docHandler1<span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">await</span> persister1<span class="punctuation">.</span><span class="function">startAutoLoad</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
@@ -6692,7 +6692,7 @@
   <span class="literal-property">network</span><span class="operator">:</span> <span class="punctuation">[</span><span class="keyword">new</span> <span class="class-name">BroadcastChannelNetworkAdapter</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">]</span><span class="punctuation">,</span>
 <span class="punctuation">}</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> docHandler2 <span class="operator">=</span> repo2<span class="punctuation">.</span><span class="function">find</span><span class="punctuation">(</span>docHandler1<span class="punctuation">.</span>documentId<span class="punctuation">)</span><span class="punctuation">;</span>
-<span class="keyword">await</span> docHandler2<span class="punctuation">.</span><span class="function">value</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+<span class="keyword">await</span> docHandler2<span class="punctuation">.</span><span class="function">doc</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> store2 <span class="operator">=</span> <span class="function"><a href="#/api/store/functions/creation/createstore/">createStore</a></span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">const</span> persister2 <span class="operator">=</span> <span class="function"><a href="#/api/persister-automerge/functions/creation/createautomergepersister/">createAutomergePersister</a></span><span class="punctuation">(</span>store2<span class="punctuation">,</span> docHandler2<span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="keyword">await</span> persister2<span class="punctuation">.</span><span class="function">startAutoLoad</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
@@ -6701,9 +6701,9 @@
 <span class="comment">// A function that waits briefly and then for the documents to synchronize</span>
 <span class="comment">// with each other, merely for the purposes of sequentiality in this example.</span>
 <span class="keyword">const</span> <span class="function-variable">syncDocsWait</span> <span class="operator">=</span> <span class="keyword">async</span> <span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="punctuation">{</span>
-  <span class="keyword">await</span> <span class="keyword">new</span> <span class="class-name">Promise</span><span class="punctuation">(</span><span class="punctuation">(</span><span class="parameter">resolve</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="function">setTimeout</span><span class="punctuation">(</span><span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="function">resolve</span><span class="punctuation">(</span><span class="number">0</span><span class="punctuation">)</span><span class="punctuation">,</span> <span class="number">10</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
-  <span class="keyword">await</span> docHandler1<span class="punctuation">.</span><span class="function">value</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
-  <span class="keyword">await</span> docHandler2<span class="punctuation">.</span><span class="function">value</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+  <span class="keyword">await</span> <span class="keyword">new</span> <span class="class-name">Promise</span><span class="punctuation">(</span><span class="punctuation">(</span><span class="parameter">resolve</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="function">setTimeout</span><span class="punctuation">(</span><span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="function">resolve</span><span class="punctuation">(</span><span class="number">0</span><span class="punctuation">)</span><span class="punctuation">,</span> <span class="number">100</span><span class="punctuation">)</span><span class="punctuation">)</span><span class="punctuation">;</span>
+  <span class="keyword">await</span> docHandler1<span class="punctuation">.</span><span class="function">doc</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
+  <span class="keyword">await</span> docHandler2<span class="punctuation">.</span><span class="function">doc</span><span class="punctuation">(</span><span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="punctuation">}</span><span class="punctuation">;</span>
 
 <span class="comment">// Wait for the documents to synchronize in their initial state.</span>
@@ -17378,4 +17378,4 @@
   editable<span class="operator">?</span><span class="operator">:</span> <span class="builtin">boolean</span><span class="punctuation">;</span>
   valueComponent<span class="operator">?</span><span class="operator">:</span> ComponentType<span class="operator">&lt;</span><span class="type"><a href="#/api/ui-react/type-aliases/props/valueprops/">ValueProps</a></span><span class="operator">></span><span class="punctuation">;</span>
   getValueComponentProps<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>valueId<span class="operator">:</span> <span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">)</span> <span class="operator">=></span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span><span class="punctuation">;</span>
-<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>store<span class="operator">?</span></code></th><td><code><span class="type"><a href="#/api/ui-react/type-aliases/identity/storeorstoreid/">StoreOrStoreId</a></span></code></td><td><p>The <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> to be accessed: omit for the default context <a href="#/api/store/interfaces/store/store/"><code>Store</code></a>, provide an <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> for a named context <a href="#/api/store/interfaces/store/store/"><code>Store</code></a>, or provide an explicit reference.</p></td></tr><tr><th><code>editable<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>Whether the <a href="#/api/store/type-aliases/store/values/"><code>Values</code></a> should be editable. This affects the default <a href="#/api/ui-react/functions/store-components/valueview/"><code>ValueView</code></a> component (to use the <a href="#/api/ui-react-dom/functions/store-components/editablevalueview/"><code>EditableValueView</code></a> component instead) but of course will not affect a custom valueComponent if you have set one.</p></td></tr><tr><th><code>valueComponent<span class="operator">?</span></code></th><td><code>ComponentType<span class="operator">&lt;</span><span class="type"><a href="#/api/ui-react/type-aliases/props/valueprops/">ValueProps</a></span><span class="operator">></span></code></td><td><p>A custom component for rendering each <a href="#/api/store/type-aliases/store/value/"><code>Value</code></a> in the <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> (to override the default <a href="#/api/ui-react/functions/store-components/valueview/"><code>ValueView</code></a> component).</p></td></tr><tr><th><code>getValueComponentProps<span class="operator">?</span></code></th><td><code><span class="punctuation">(</span>valueId<span class="operator">:</span> <span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">)</span> <span class="operator">=></span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span></code></td><td><p>A function for generating extra props for each custom <a href="#/api/store/type-aliases/store/value/"><code>Value</code></a> component based on its <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p></td></tr></table></div><section class="s6"><h6>Since</h6><p>v4.1.0</p></section></section></section></section></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.6.2</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>
+<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>store<span class="operator">?</span></code></th><td><code><span class="type"><a href="#/api/ui-react/type-aliases/identity/storeorstoreid/">StoreOrStoreId</a></span></code></td><td><p>The <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> to be accessed: omit for the default context <a href="#/api/store/interfaces/store/store/"><code>Store</code></a>, provide an <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> for a named context <a href="#/api/store/interfaces/store/store/"><code>Store</code></a>, or provide an explicit reference.</p></td></tr><tr><th><code>editable<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>Whether the <a href="#/api/store/type-aliases/store/values/"><code>Values</code></a> should be editable. This affects the default <a href="#/api/ui-react/functions/store-components/valueview/"><code>ValueView</code></a> component (to use the <a href="#/api/ui-react-dom/functions/store-components/editablevalueview/"><code>EditableValueView</code></a> component instead) but of course will not affect a custom valueComponent if you have set one.</p></td></tr><tr><th><code>valueComponent<span class="operator">?</span></code></th><td><code>ComponentType<span class="operator">&lt;</span><span class="type"><a href="#/api/ui-react/type-aliases/props/valueprops/">ValueProps</a></span><span class="operator">></span></code></td><td><p>A custom component for rendering each <a href="#/api/store/type-aliases/store/value/"><code>Value</code></a> in the <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> (to override the default <a href="#/api/ui-react/functions/store-components/valueview/"><code>ValueView</code></a> component).</p></td></tr><tr><th><code>getValueComponentProps<span class="operator">?</span></code></th><td><code><span class="punctuation">(</span>valueId<span class="operator">:</span> <span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">)</span> <span class="operator">=></span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span></code></td><td><p>A function for generating extra props for each custom <a href="#/api/store/type-aliases/store/value/"><code>Value</code></a> component based on its <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p></td></tr></table></div><section class="s6"><h6>Since</h6><p>v4.1.0</p></section></section></section></section></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.6.3</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>

docs/api/checkpoints/functions/creation/createcheckpoints/index.html

@@ -7,4 +7,4 @@
 <span class="keyword">const</span> checkpoints2 <span class="operator">=</span> <span class="function"><a href="/api/checkpoints/functions/creation/createcheckpoints/">createCheckpoints</a></span><span class="punctuation">(</span>store<span class="punctuation">)</span><span class="punctuation">;</span>
 console<span class="punctuation">.</span><span class="function">log</span><span class="punctuation">(</span>checkpoints1 <span class="operator">===</span> checkpoints2<span class="punctuation">)</span><span class="punctuation">;</span>
 <span class="comment">// -> true</span>
-</code></pre></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.6.2</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>
+</code></pre></section></section></article><aside></aside></main><footer><nav><a id="tw" href="https://twitter.com/tinybasejs" target="_blank">Twitter</a><a id="fb" href="https://facebook.com/tinybasejs" target="_blank">Facebook</a></nav><nav><a href="/">TinyBase 4.6.3</a> © 2021- All Rights Reserved</nav></footer></body><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><script>window.dataLayer=window.dataLayer||[];function g(){dataLayer.push(arguments);}g('js',new Date());g('config','G-D1MGR8VRWJ');</script></html>