deploy: cerebral/cerebral@348c743

Author: cerebral[bot]

docs-text.js

@@ -483,7 +483,7 @@
                   " href="/docs/resources/index.html#utilities-state-forms">state-forms</a><ul><li><a class="nav_toggle-label nav_item-name nav_sublink
                   nav_childless" href="/docs/resources/index.html#utilities-state-forms-description">Description</a></li></ul></li><li><input id="/docs/resources/index.html#utilities-@cerebral/storage" class="nav_toggle" type="checkbox"/><a class="nav_toggle-label nav_item-name nav_sublink
                   " href="/docs/resources/index.html#utilities-@cerebral/storage">@cerebral/storage</a><ul><li><a class="nav_toggle-label nav_item-name nav_sublink
-                  nav_childless" href="/docs/resources/index.html#utilities-@cerebral/storage-description-(storage)">Description (storage)</a></li></ul></li></ul></li></ul></li></ul></div><div class="docs-doc"><div class="docs-doc-content"><h1 id="typescript-with-cerebral">TypeScript with Cerebral</h1><div style="background-color:#FAFAFA;border-left:4px solid #f44336;border-radius:3px;padding:10px 15px;color:#666"><p><strong>IMPORTANT</strong>: Even though Cerebral fully supports TypeScript, you might also want to consider Cerebral’s successor, <a href="https://overmindjs.org" target="new">Overmind</a>, which was built from the ground up with TypeScript support and modern JavaScript features.</p></div><p>Cerebral provides comprehensive type safety for your application. You can add typing gradually, so let’s take this step by step. You can stop at any level when you feel you have enough type safety for your needs.</p><h2>Required: Setting Up Proxy Support<a href="#typescript-with-cerebral-required:-setting-up-proxy-support">∞</a><span id="typescript-with-cerebral-required:-setting-up-proxy-support"> </span></h2><p>Cerebral uses proxies for type-safe state and sequences access. To set up these typed proxies, create a file called <strong>app.cerebral.ts</strong>:</p><div style="background-color:#FAFAFA;border-left:4px solid #f4ca36;border-radius:3px;padding:10px 15px;color:#666"><p>You MUST use the <a href="https://www.npmjs.com/package/babel-plugin-cerebral" target="new">babel-plugin-cerebral</a> package. This plugin transforms the typed proxies into template literal tags behind the scenes.</p></div><pre><code class="language-ts"><span class="token keyword">import</span> <span class="token operator">*</span> as cerebral <span class="token keyword">from</span> <span class="token string">'cerebral'</span>
+                  nav_childless" href="/docs/resources/index.html#utilities-@cerebral/storage-description-(storage)">Description (storage)</a></li></ul></li></ul></li></ul></li></ul></div><div class="docs-doc"><div class="docs-doc-content"><h1 id="typescript-with-cerebral">TypeScript with Cerebral</h1><div style="background-color:#FAFAFA;border-left:4px solid #f44336;border-radius:3px;padding:10px 15px;color:#666"><p><strong>IMPORTANT</strong>: Even though Cerebral fully supports TypeScript, you might also want to consider Cerebral’s successor, <a href="https://overmindjs.org" target="new">Overmind</a>, which was built from the ground up with TypeScript support and modern JavaScript features.</p></div><p>Cerebral provides comprehensive type safety for your application. You can add typing gradually, so let’s take this step by step. You can stop at any level when you feel you have enough type safety for your needs.</p><h2>Required: Setting Up Proxy Support<a href="#typescript-with-cerebral-required:-setting-up-proxy-support">∞</a><span id="typescript-with-cerebral-required:-setting-up-proxy-support"> </span></h2><p>Cerebral uses proxies for type-safe state and sequences access. To set up these typed proxies, create a file called <strong>app.cerebral.ts</strong>:</p><div style="background-color:#FAFAFA;border-left:4px solid #f4ca36;border-radius:3px;padding:10px 15px;color:#666"><p>You MUST use the <a href="https://www.npmjs.com/package/@cerebral/babel-plugin" target="new">@cerebral/babel-plugin</a> package. This plugin transforms the typed proxies into template literal tags behind the scenes.</p></div><pre><code class="language-ts"><span class="token keyword">import</span> <span class="token operator">*</span> as cerebral <span class="token keyword">from</span> <span class="token string">'cerebral'</span>
 
 type State <span class="token operator">=</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
 

docs/advanced/typescript.html

@@ -536,12 +536,12 @@
     <span class="token keyword">continue</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token function">unset</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">notification</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token literal-property property">discard</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
   <span class="token punctuation">}</span>
-<span class="token punctuation">]</span></code></pre><div style="background-color:#FAFAFA;border-left:4px solid #f44336;border-radius:3px;padding:10px 15px;color:#666"><p>The <code>discard</code> path must always be present when using debounce, even if you don’t need to run any actions when debounce is abandoned.</p></div><h3>equals<a href="#factories-flow-control-factories-equals">∞</a><span id="factories-flow-control-factories-equals"> </span></h3><p>Branch execution based on a value comparison:</p><pre><code class="language-js"><span class="token function">equals</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.role</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+<span class="token punctuation">]</span></code></pre><div style="background-color:#FAFAFA;border-left:4px solid #f44336;border-radius:3px;padding:10px 15px;color:#666"><p>The <code>discard</code> path must always be present when using debounce, even if you don’t need to run any actions when debounce is abandoned.</p></div><h3>equals<a href="#factories-flow-control-factories-equals">∞</a><span id="factories-flow-control-factories-equals"> </span></h3><p>Branch execution based on a value comparison:</p><pre><code class="language-js"><span class="token punctuation">;</span><span class="token punctuation">(</span><span class="token function">equals</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.role</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">,</span>
   <span class="token punctuation">{</span>
     <span class="token literal-property property">admin</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>loadAdminPage<span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token literal-property property">user</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>loadUserPage<span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token literal-property property">otherwise</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>redirectToLogin<span class="token punctuation">]</span>
-  <span class="token punctuation">}</span></code></pre><h3>wait<a href="#factories-flow-control-factories-wait">∞</a><span id="factories-flow-control-factories-wait"> </span></h3><p>Pause execution for a specified time:</p><pre><code class="language-js"><span class="token comment">// Simple waiting</span>
+  <span class="token punctuation">}</span><span class="token punctuation">)</span></code></pre><h3>wait<a href="#factories-flow-control-factories-wait">∞</a><span id="factories-flow-control-factories-wait"> </span></h3><p>Pause execution for a specified time:</p><pre><code class="language-js"><span class="token comment">// Simple waiting</span>
 <span class="token punctuation">;</span><span class="token punctuation">[</span><span class="token function">wait</span><span class="token punctuation">(</span><span class="token number">500</span><span class="token punctuation">)</span><span class="token punctuation">,</span> actions<span class="token punctuation">.</span>afterWaiting<span class="token punctuation">]</span>
 
 <span class="token comment">// Within parallel execution</span>
@@ -554,29 +554,29 @@
   <span class="token punctuation">]</span><span class="token punctuation">,</span>
   actions<span class="token punctuation">.</span>runInParallel
 <span class="token punctuation">]</span><span class="token punctuation">)</span></code></pre><h3>when<a href="#factories-flow-control-factories-when">∞</a><span id="factories-flow-control-factories-when"> </span></h3><p>Conditionally choose a path based on a value or predicate:</p><pre><code class="language-js"><span class="token comment">// With direct value</span>
-<span class="token function">when</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.isLoggedIn</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+<span class="token punctuation">;</span><span class="token punctuation">(</span><span class="token function">when</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.isLoggedIn</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">,</span>
   <span class="token punctuation">{</span>
     <span class="token boolean">true</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>redirectToDashboard<span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token boolean">false</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>showLoginForm<span class="token punctuation">]</span>
-  <span class="token punctuation">}</span>
+  <span class="token punctuation">}</span><span class="token punctuation">)</span>
 
 <span class="token comment">// With custom predicate</span>
-<span class="token function">when</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.role</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">role</span><span class="token punctuation">)</span> <span class="token operator">=></span> role <span class="token operator">===</span> <span class="token string">'admin'</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+<span class="token punctuation">;</span><span class="token punctuation">(</span><span class="token function">when</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">user.role</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">role</span><span class="token punctuation">)</span> <span class="token operator">=></span> role <span class="token operator">===</span> <span class="token string">'admin'</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
   <span class="token punctuation">{</span>
     <span class="token boolean">true</span><span class="token operator">:</span> <span class="token punctuation">[</span>actions<span class="token punctuation">.</span>showAdminTools<span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token boolean">false</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
-  <span class="token punctuation">}</span>
+  <span class="token punctuation">}</span><span class="token punctuation">)</span>
 
 <span class="token comment">// With multiple arguments</span>
-<span class="token function">when</span><span class="token punctuation">(</span>
+<span class="token punctuation">;</span><span class="token punctuation">(</span><span class="token function">when</span><span class="token punctuation">(</span>
   state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">inputValue</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span>
   state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">minLength</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span>
   <span class="token punctuation">(</span><span class="token parameter">value<span class="token punctuation">,</span> minLength</span><span class="token punctuation">)</span> <span class="token operator">=></span> value<span class="token punctuation">.</span>length <span class="token operator">>=</span> minLength
 <span class="token punctuation">)</span><span class="token punctuation">,</span>
   <span class="token punctuation">{</span>
     <span class="token boolean">true</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token function">set</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">isValid</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
     <span class="token boolean">false</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token function">set</span><span class="token punctuation">(</span>state<span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">isValid</span><span class="token template-punctuation string">`</span></span><span class="token punctuation">,</span> <span class="token boolean">false</span><span class="token punctuation">)</span><span class="token punctuation">]</span>
-  <span class="token punctuation">}</span></code></pre><h2>Sequence and Parallel<a href="#factories-sequence-and-parallel">∞</a><span id="factories-sequence-and-parallel"> </span></h2><p>These factories help compose sequences and run actions in parallel:</p><pre><code class="language-js"><span class="token keyword">import</span> <span class="token punctuation">{</span> sequence<span class="token punctuation">,</span> parallel <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'cerebral/factories'</span>
+  <span class="token punctuation">}</span><span class="token punctuation">)</span></code></pre><h2>Sequence and Parallel<a href="#factories-sequence-and-parallel">∞</a><span id="factories-sequence-and-parallel"> </span></h2><p>These factories help compose sequences and run actions in parallel:</p><pre><code class="language-js"><span class="token keyword">import</span> <span class="token punctuation">{</span> sequence<span class="token punctuation">,</span> parallel <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'cerebral/factories'</span>
 
 <span class="token comment">// Create a named sequence</span>
 <span class="token keyword">export</span> <span class="token keyword">const</span> mySequence <span class="token operator">=</span> <span class="token function">sequence</span><span class="token punctuation">(</span><span class="token string">'My Sequence'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span>