Skip to content

Commit

Permalink
publish typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@cmorten @actions-user
cmorten authored and actions-user committed Nov 21, 2021
1 parent 5125ecc commit 68ca046
Show file tree
Hide file tree
Showing 17 changed files with 250 additions and 222 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

132 changes: 66 additions & 66 deletions docs/classes/_test_.test.html
View file

Large diffs are not rendered by default.

23 changes: 12 additions & 11 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ <h2>Table of Contents</h2>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno@4.7.0/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@1.7.2/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@1.9.1/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> app = opine();

Expand Down Expand Up @@ -138,12 +138,13 @@ <h2>Installation</h2>
repo and via the <a href="https://deno.land/x">Deno Registry</a>.</p>
<p>Before importing, <a href="https://deno.land/#installation">download and install Deno</a>.</p>
<p>You can then import SuperDeno straight into your project:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno@4.7.0/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno/mod.ts&quot;</span>;
</code></pre>
<p>SuperDeno is also available on <a href="https://nest.land/package/superdeno">nest.land</a>,
a package registry for Deno on the Blockchain.</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://x.nest.land/superdeno@4.7.0/mod.ts&quot;</span>;
</code></pre>
<blockquote>
<p>Note: All examples in this README are using the unversioned form of the import URL. In production you should always use the versioned import form such as <code>https://deno.land/x/superdeno@4.7.0/mod.ts</code>.</p>
</blockquote>
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
<h2>Example</h2>
</a>
Expand All @@ -167,8 +168,8 @@ <h2>Example</h2>
});
</code></pre>
<p>Here&#39;s an example of SuperDeno working with the Opine web framework:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@1.7.2/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno@4.7.0/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@1.9.1/mod.ts&quot;</span>;
<span class="hljs-keyword">export</span> { expect } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/expect@v0.2.9/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> app = opine();
Expand All @@ -189,8 +190,8 @@ <h2>Example</h2>
});
</code></pre>
<p>Here&#39;s an example of SuperDeno working with the Oak web framework:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { Application, Router } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/oak@v9.0.1/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno@4.7.0/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { Application, Router } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/oak@v10.0.0/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> router = <span class="hljs-keyword">new</span> Router();
router.get(<span class="hljs-string">&quot;/&quot;</span>, <span class="hljs-function">(<span class="hljs-params">ctx</span>) =&gt;</span> {
Expand Down Expand Up @@ -226,8 +227,8 @@ <h2>Example</h2>
<p>If you don&#39;t need to test the server setup side of your Oak application, or you
are making use of the <code>app.handle()</code> method (for example for serverless apps)
then you can write slightly less verbose tests for Oak:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { Application, Router } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/oak@v9.0.1/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno@4.7.0/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { Application, Router } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/oak@v10.0.0/mod.ts&quot;</span>;
<span class="hljs-keyword">import</span> { superdeno } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/superdeno/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> router = <span class="hljs-keyword">new</span> Router();

Expand Down
Loading

0 comments on commit 68ca046

Please sign in to comment.