v4.8.8

Author: jamesgpearce

docs/api/all.html

@@ -13479,7 +13479,7 @@
 </code></pre></section></section><section class="s5" id="/api/ui-react/functions/store-hooks/useprovidestore/" data-id="uPS"><h5><code>useProvideStore</code></h5><p>The <code>useProvideStore</code> hook is used to add a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> object by <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> to a <a href="#/api/ui-react/functions/context-components/provider/"><code>Provider</code></a> component, but imperatively from a component within it.</p><pre><code><span class="function"><a href="#/api/ui-react/functions/store-hooks/useprovidestore/">useProvideStore</a></span><span class="punctuation">(</span>
   storeId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span>
   store<span class="operator">:</span> <span class="type"><a href="#/api/store/interfaces/store/store/">Store</a></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>storeId</code></th><td><code><span class="builtin">string</span></code></td><td><p>The <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> object to be registered with the Provider.</p></td></tr><tr><th><code>store</code></th><td><code><span class="type"><a href="#/api/store/interfaces/store/store/">Store</a></span></code></td><td><p>The <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> object to be registered.</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>Normally you will register a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> by <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> in a context by using the <code>storesById</code> prop of the top-level <a href="#/api/ui-react/functions/context-components/provider/"><code>Provider</code></a> component. This hook, however, lets you dynamically add a new <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> to the context, from within a descendent component. This is useful for applications where the set of Stores is not known at the time of the first render of the root Provider.</p><p>A <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> added to the Provider context in this way will be available to other components within the context (using the <a href="#/api/ui-react/functions/store-hooks/usestore/"><code>useStore</code></a> hook and so on). If you use the same <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> as an existing <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> registration, the new one will take priority over one provided by the <code>storesById</code> prop.</p><p>Note that other components that consume a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> registered like this should defend against it being undefined at first. On the first render, the other component will likely not yet have completed the registration. In the example below, we use the null-safe <code>useStore(&#x27;petStore&#x27;)?.[</code>getTableIds<code>](#/api/store/interfaces/store/store/methods/getter/gettableids/)()</code> to do this.</p><section class="s6"><h6>Example</h6><p>This example creates a Provider context. A child component registers a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> into it which is then consumable by a peer child component.</p><pre><code><span class="keyword">const</span> <span class="function-variable">App</span> <span class="operator">=</span> <span class="punctuation">(</span><span class="punctuation">)</span> <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>storeId</code></th><td><code><span class="builtin">string</span></code></td><td><p>The <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> object to be registered with the Provider.</p></td></tr><tr><th><code>store</code></th><td><code><span class="type"><a href="#/api/store/interfaces/store/store/">Store</a></span></code></td><td><p>The <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> object to be registered.</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>Normally you will register a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> by <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> in a context by using the <code>storesById</code> prop of the top-level <a href="#/api/ui-react/functions/context-components/provider/"><code>Provider</code></a> component. This hook, however, lets you dynamically add a new <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> to the context, from within a descendent component. This is useful for applications where the set of Stores is not known at the time of the first render of the root Provider.</p><p>A <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> added to the Provider context in this way will be available to other components within the context (using the <a href="#/api/ui-react/functions/store-hooks/usestore/"><code>useStore</code></a> hook and so on). If you use the same <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> as an existing <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> registration, the new one will take priority over one provided by the <code>storesById</code> prop.</p><p>Note that other components that consume a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> registered like this should defend against it being undefined at first. On the first render, the other component will likely not yet have completed the registration. In the example below, we use the null-safe <code>useStore(&#x27;petStore&#x27;)?</code> to do this.</p><section class="s6"><h6>Example</h6><p>This example creates a Provider context. A child component registers a <a href="#/api/store/interfaces/store/store/"><code>Store</code></a> into it which is then consumable by a peer child component.</p><pre><code><span class="keyword">const</span> <span class="function-variable">App</span> <span class="operator">=</span> <span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="punctuation">(</span>
   <span class="tag"><span class="tag"><span class="punctuation">&lt;</span><span class="class-name"><a href="#/api/ui-react/functions/context-components/provider/">Provider</a></span></span><span class="punctuation">></span></span><span class="plain-text">
     </span><span class="tag"><span class="tag"><span class="punctuation">&lt;</span><span class="class-name">RegisterStore</span></span> <span class="punctuation">/></span></span><span class="plain-text">
     </span><span class="tag"><span class="tag"><span class="punctuation">&lt;</span><span class="class-name">ConsumeStore</span></span> <span class="punctuation">/></span></span><span class="plain-text">
@@ -18205,4 +18205,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.8.7</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.8.8</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.8.7</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.8.8</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>