Skip to content

Commit

Permalink
[ISSUE-1] Decouple SuperOak from Oak v5.0.0 to prevent type errors (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
@asos-craigmorten
asos-craigmorten authored Jun 2, 2020
1 parent 5371840 commit c4eb4a8
Show file tree
Hide file tree
Showing 8 changed files with 293 additions and 261 deletions.
4 changes: 4 additions & 0 deletions .github/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ChangeLog

## [1.0.1] - 02-06-2020

- fix: decouple SuperOak from Oak v5.0.0 to prevent type errors.

## [1.0.0] - 01-06-2020

- feat: initial Oak extension for SuperDeno - _SuperOak_.
1 change: 0 additions & 1 deletion deps.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ export {
IRequest,
IResponse,
} from "https://deno.land/x/superdeno@1.1.1/mod.ts";
export * from "https://deno.land/x/oak@v5.0.0/mod.ts";
export { methods } from "https://deno.land/x/opine@0.8.0/mod.ts";
export {
getFreePort,
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"kinds":{"1":"Module","64":"Function"},"rows":[{"id":0,"kind":1,"name":"\"superoak\"","url":"modules/_superoak_.html","classes":"tsd-kind-module"},{"id":1,"kind":64,"name":"random","url":"modules/_superoak_.html#random","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported","parent":"\"superoak\""},{"id":2,"kind":64,"name":"superoak","url":"modules/_superoak_.html#superoak","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"superoak\""}],"index":{"version":"2.3.8","fields":["name","parent"],"fieldVectors":[["name/0",[0,1.054]],["parent/0",[]],["name/1",[1,9.808]],["parent/1",[0,0.087]],["name/2",[0,1.054]],["parent/2",[0,0.087]]],"invertedIndex":[["random",{"_index":1,"name":{"1":{}},"parent":{}}],["superoak",{"_index":0,"name":{"0":{},"2":{}},"parent":{"1":{},"2":{}}}]],"pipeline":[]}}
{"kinds":{"1":"Module","64":"Function"},"rows":[{"id":0,"kind":1,"name":"\"superoak\"","url":"modules/_superoak_.html","classes":"tsd-kind-module"},{"id":1,"kind":64,"name":"random","url":"modules/_superoak_.html#random","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported","parent":"\"superoak\""},{"id":2,"kind":64,"name":"isOakApplication","url":"modules/_superoak_.html#isoakapplication","classes":"tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported","parent":"\"superoak\""},{"id":3,"kind":64,"name":"superoak","url":"modules/_superoak_.html#superoak","classes":"tsd-kind-function tsd-parent-kind-module","parent":"\"superoak\""}],"index":{"version":"2.3.8","fields":["name","parent"],"fieldVectors":[["name/0",[0,0.87]],["parent/0",[]],["name/1",[1,12.04]],["parent/1",[0,0.077]],["name/2",[2,12.04]],["parent/2",[0,0.077]],["name/3",[0,0.87]],["parent/3",[0,0.077]]],"invertedIndex":[["isoakapplication",{"_index":2,"name":{"2":{}},"parent":{}}],["random",{"_index":1,"name":{"1":{}},"parent":{}}],["superoak",{"_index":0,"name":{"0":{},"3":{}},"parent":{"1":{},"2":{},"3":{}}}]],"pipeline":[]}}
42 changes: 38 additions & 4 deletions docs/modules/_superoak_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"><a href="_superoak_.html#isoakapplication" class="tsd-kind-icon">is<wbr>Oak<wbr>Application</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"><a href="_superoak_.html#random" class="tsd-kind-icon">random</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_superoak_.html#superoak" class="tsd-kind-icon">superoak</a></li>
</ul>
Expand All @@ -80,6 +81,36 @@ <h3>Functions</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
<a name="isoakapplication" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Oak<wbr>Application</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">is<wbr>Oak<wbr>Application<span class="tsd-signature-symbol">(</span>thing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/superoak/blob/5371840/src/superoak.ts#L25">superoak.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Duck typing to determine if is Oak application like.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>thing: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
<a name="random" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> random</h3>
Expand All @@ -90,7 +121,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> random</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in superoak.ts:17</li>
<li>Defined in <a href="https://github.com/asos-craigmorten/superoak/blob/5371840/src/superoak.ts#L11">superoak.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -117,13 +148,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<a name="superoak" class="tsd-anchor"></a>
<h3>superoak</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">superoak<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Application</span>, secure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SuperDeno</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">superoak<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span>, secure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SuperDeno</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in superoak.ts:36</li>
<li>Defined in <a href="https://github.com/asos-craigmorten/superoak/blob/5371840/src/superoak.ts#L45">superoak.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +169,7 @@ <h3>superoak</h3>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>app: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Application</span></h5>
<h5>app: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> secure: <span class="tsd-signature-type">boolean</span></h5>
Expand All @@ -165,6 +196,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
<a href="_superoak_.html#isoakapplication" class="tsd-kind-icon">is<wbr>Oak<wbr>Application</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
<a href="_superoak_.html#random" class="tsd-kind-icon">random</a>
</li>
Expand Down
Loading

0 comments on commit c4eb4a8

Please sign in to comment.