Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Mar 2, 2020
1 parent 78544f9 commit 7fa6a0a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link rel="icon" href="/db/favicon.ico"/><title>@magic-libraries/db</title><meta name="description" content="localstorage backed browser key value database for @magic"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-libraries/db"}</script><link rel="stylesheet" href="/db/magic.css?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/db/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/db/"><span>@magic-libraries/db</span></a><nav class="Menu"><ul><li><a href="/db/#installation">installation</a></li><li><a href="/db/#usage">usage</a></li><li><a href="/db/#source">source</a></li></ul></nav></header><div class="Page" id="page"><div>404 - not found</div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/db/magic.js?d+mJGbTSuO" integrity="sha384-d+mJGbTSuOsiBoqRocOYpcTUy12/kt0bdnXSbPi+tbI13fGRNwpU70NtBe5DRafu" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link rel="icon" href="/db/favicon.ico"/><title>@magic-libraries/db</title><meta name="description" content="localstorage backed browser key value database for @magic"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-libraries/db"}</script><link rel="stylesheet" href="/db/magic.css?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/db/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/db/"><span>@magic-libraries/db</span></a><nav class="Menu"><ul><li><a href="/db/#installation">installation</a></li><li><a href="/db/#usage">usage</a></li><li><a href="/db/#source">source</a></li></ul></nav></header><div class="Page" id="page"><div>404 - not found</div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/db/magic.js?I0p3E48a0N" integrity="sha384-I0p3E48a0Nmya4bftObH0aBsZYOSxS6TOe1BAhTXUeiNNPM6orGZIo3Dwkppd/q6" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
for an actual usecase</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">const</span> View = ({ key, <span class="state">state</span> }) =&gt;</code><code class="line"> div([</code><code class="line"> div([<span class="string">&#39;<span class="colon">key</span>: key]),&#39;</span></code><code class="line"> div([</code><code class="line"> h4(<span class="string">&#39;controls&#39;</span>),</code><code class="line"> button({ <span class="colon">onclick</span>: [<span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="property">set</span>, { key }] }, <span class="string">&#39;write&#39;</span>),</code><code class="line"> button({ <span class="colon">onclick</span>: [<span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="keyword">get</span>, { key }] }, <span class="string">&#39;read&#39;</span>),</code><code class="line"> button({ <span class="colon">onclick</span>: [<span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="property">del</span>, { key }] }, <span class="string">&#39;<span class="keyword">delete</span>&#39;</span>),</code><code class="line"> ]),</code><code class="line"></code><code class="line"> div(<span class="string">&#39;value <span class="keyword">in</span> local <span class="colon">storage</span>:&#39;</span>),</code><code class="line"> <span class="state">state</span>[key]</code><code class="line"> ? [<span class="string">&#39;<span class="state">state</span> is accessible via <span class="state">state</span>[&#39;</span><span class="string">&#39; + key + &#39;</span><span class="string">&#39;] div(<span class="state">state</span>[key])]&#39;</span></code><code class="line"> : div(<span class="string">&#39;no value <span class="keyword">in</span> db&#39;</span>),</code><code class="line"> ])</code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">const</span> <span class="actions">actions</span> = {</code><code class="line"> <span class="colon">examplestore</span>: {</code><code class="line"> <span class="colon">get</span>: (<span class="state">state</span>, { key }) =&gt; [</code><code class="line"> <span class="state">state</span>,</code><code class="line"> [</code><code class="line"> <span class="object">lib</span>.<span class="property">db</span>.<span class="keyword">get</span>,</code><code class="line"> {</code><code class="line"> key,</code><code class="line"> <span class="colon">action</span>: <span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="property">refresh</span>,</code><code class="line"> },</code><code class="line"> ],</code><code class="line"> ],</code><code class="line"></code><code class="line"> <span class="colon">set</span>: (<span class="state">state</span>, { key }) =&gt; [</code><code class="line"> <span class="state">state</span>,</code><code class="line"> [</code><code class="line"> <span class="object">lib</span>.<span class="property">db</span>.<span class="property">set</span>,</code><code class="line"> {</code><code class="line"> key,</code><code class="line"> <span class="colon">value</span>: <span class="string">&#39;testing &#39;</span> + <span class="object">Math</span>.<span class="property">ceil</span>(<span class="object">Math</span>.<span class="property">random</span>() * 100000),</code><code class="line"> <span class="colon">action</span>: <span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="property">refresh</span>,</code><code class="line"> },</code><code class="line"> ],</code><code class="line"> ],</code><code class="line"></code><code class="line"> <span class="colon">del</span>: (<span class="state">state</span>, { key }) =&gt; [</code><code class="line"> <span class="state">state</span>,</code><code class="line"> [</code><code class="line"> <span class="object">lib</span>.<span class="property">db</span>.<span class="property">del</span>,</code><code class="line"> {</code><code class="line"> key,</code><code class="line"> <span class="colon">action</span>: <span class="actions">actions</span>.<span class="property">examplestore</span>.<span class="property">refresh</span>,</code><code class="line"> },</code><code class="line"> ],</code><code class="line"> ],</code><code class="line"></code><code class="line"> <span class="colon">refresh</span>: (<span class="state">state</span>, { key, value }) =&gt; {</code><code class="line"> <span class="object">console</span>.<span class="property">log</span>(<span class="string">&#39;refresh { key, value })&#39;</span></code><code class="line"></code><code class="line"> <span class="keyword">if</span> (key) {</code><code class="line"> <span class="state">state</span>[key] = value</code><code class="line"> }</code><code class="line"></code><code class="line"> <span class="keyword">return</span> {</code><code class="line"> ...<span class="state">state</span>,</code><code class="line"> }</code><code class="line"> },</code><code class="line"> },</code><code class="line">}</code></pre></div><p>then use it in a page:</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;ExampleStore <span class="state">state</span> key=<span class="string">&#39;magic-examplestore&#39;</span>&gt;&lt;/ExampleStore&gt;</code></pre></div><p>renders:</p><div><div>key: magic-examplestore</div><div><h4>controls</h4><button>write</button><button>read</button><button>delete</button></div><div>value in local storage:</div><div>no value in db</div></div><h3 id="source">source</h3><p>the source for this page is in the
<a href="https://github.com/magic-libraries/db/tree/master/example" target="_blank" rel="noopener">example directory</a>
and gets built and published to github using
<a href="https://github.com/magic/core" target="_blank" rel="noopener">@magic/core</a></p></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/db/magic.js?d+mJGbTSuO" integrity="sha384-d+mJGbTSuOsiBoqRocOYpcTUy12/kt0bdnXSbPi+tbI13fGRNwpU70NtBe5DRafu" crossorigin="anonymous"></script></body></html>
<a href="https://github.com/magic/core" target="_blank" rel="noopener">@magic/core</a></p></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/db/magic.js?I0p3E48a0N" integrity="sha384-I0p3E48a0Nmya4bftObH0aBsZYOSxS6TOe1BAhTXUeiNNPM6orGZIo3Dwkppd/q6" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit 7fa6a0a

Please sign in to comment.