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 28, 2021
1 parent df481ad commit 3e5a855
Show file tree
Hide file tree
Showing 71 changed files with 2,680 additions and 12,996 deletions.
2,408 changes: 51 additions & 2,357 deletions docs/assets/js/main.js
View file

Large diffs are not rendered by default.

9,386 changes: 1 addition & 9,385 deletions docs/assets/js/search.json
View file

Large diffs are not rendered by default.

1,336 changes: 1,336 additions & 0 deletions docs/classes/_request_.wrappedrequest.html
View file

Large diffs are not rendered by default.

121 changes: 77 additions & 44 deletions docs/classes/_response_.response.html
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/classes/_utils_createerror_.httperror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L18">home/runner/work/opine/opine/src/utils/createError.ts:18</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L18">home/runner/work/opine/opine/src/utils/createError.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -158,7 +158,7 @@ <h3>expose</h3>
<div class="tsd-signature tsd-kind-icon">expose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L17">home/runner/work/opine/opine/src/utils/createError.ts:17</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L17">home/runner/work/opine/opine/src/utils/createError.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -169,7 +169,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Overrides <a href="../interfaces/_utils_createerror_.ierror.html">IError</a>.<a href="../interfaces/_utils_createerror_.ierror.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L14">home/runner/work/opine/opine/src/utils/createError.ts:14</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L14">home/runner/work/opine/opine/src/utils/createError.ts:14</a></li>
</ul>
</aside>
</section>
Expand All @@ -180,7 +180,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Overrides <a href="../interfaces/_utils_createerror_.ierror.html">IError</a>.<a href="../interfaces/_utils_createerror_.ierror.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L13">home/runner/work/opine/opine/src/utils/createError.ts:13</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L13">home/runner/work/opine/opine/src/utils/createError.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -191,7 +191,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#stack">stack</a></p>
<ul>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:975</li>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:1024</li>
</ul>
</aside>
</section>
Expand All @@ -201,7 +201,7 @@ <h3>status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L15">home/runner/work/opine/opine/src/utils/createError.ts:15</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L15">home/runner/work/opine/opine/src/utils/createError.ts:15</a></li>
</ul>
</aside>
</section>
Expand All @@ -211,7 +211,7 @@ <h3>status<wbr>Code</h3>
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L16">home/runner/work/opine/opine/src/utils/createError.ts:16</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L16">home/runner/work/opine/opine/src/utils/createError.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -221,7 +221,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:984</li>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:1033</li>
</ul>
</aside>
</section>
Expand All @@ -238,7 +238,7 @@ <h3>toJSON</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L56">home/runner/work/opine/opine/src/utils/createError.ts:56</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L56">home/runner/work/opine/opine/src/utils/createError.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
Expand Down Expand Up @@ -266,7 +266,7 @@ <h3>to<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L52">home/runner/work/opine/opine/src/utils/createError.ts:52</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L52">home/runner/work/opine/opine/src/utils/createError.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand Down
18 changes: 9 additions & 9 deletions docs/classes/_utils_createerror_.httperrorimpl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L18">home/runner/work/opine/opine/src/utils/createError.ts:18</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L18">home/runner/work/opine/opine/src/utils/createError.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -154,7 +154,7 @@ <h3>expose</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#expose">expose</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L17">home/runner/work/opine/opine/src/utils/createError.ts:17</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L17">home/runner/work/opine/opine/src/utils/createError.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -166,7 +166,7 @@ <h3>message</h3>
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#message">message</a></p>
<p>Overrides <a href="../interfaces/_utils_createerror_.ierror.html">IError</a>.<a href="../interfaces/_utils_createerror_.ierror.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L14">home/runner/work/opine/opine/src/utils/createError.ts:14</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L14">home/runner/work/opine/opine/src/utils/createError.ts:14</a></li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +178,7 @@ <h3>name</h3>
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#name">name</a></p>
<p>Overrides <a href="../interfaces/_utils_createerror_.ierror.html">IError</a>.<a href="../interfaces/_utils_createerror_.ierror.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L13">home/runner/work/opine/opine/src/utils/createError.ts:13</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L13">home/runner/work/opine/opine/src/utils/createError.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -189,7 +189,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#stack">stack</a></p>
<ul>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:975</li>
<li>Defined in opt/hostedtoolcache/node/12.22.7/x64/lib/node_modules/typescript/lib/lib.es5.d.ts:1024</li>
</ul>
</aside>
</section>
Expand All @@ -200,7 +200,7 @@ <h3>status</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#status">status</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L15">home/runner/work/opine/opine/src/utils/createError.ts:15</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L15">home/runner/work/opine/opine/src/utils/createError.ts:15</a></li>
</ul>
</aside>
</section>
Expand All @@ -211,7 +211,7 @@ <h3>status<wbr>Code</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#statuscode">statusCode</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L16">home/runner/work/opine/opine/src/utils/createError.ts:16</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L16">home/runner/work/opine/opine/src/utils/createError.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -229,7 +229,7 @@ <h3>toJSON</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#tojson">toJSON</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L56">home/runner/work/opine/opine/src/utils/createError.ts:56</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L56">home/runner/work/opine/opine/src/utils/createError.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
Expand Down Expand Up @@ -258,7 +258,7 @@ <h3>to<wbr>String</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_createerror_.httperror.html">HttpError</a>.<a href="_utils_createerror_.httperror.html#tostring">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/utils/createError.ts#L52">home/runner/work/opine/opine/src/utils/createError.ts:52</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/utils/createError.ts#L52">home/runner/work/opine/opine/src/utils/createError.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand Down
20 changes: 10 additions & 10 deletions docs/classes/_view_.view.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L35">home/runner/work/opine/opine/src/view.ts:35</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L35">home/runner/work/opine/opine/src/view.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -159,7 +159,7 @@ <h3>default<wbr>Engine</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L30">home/runner/work/opine/opine/src/view.ts:30</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L30">home/runner/work/opine/opine/src/view.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -169,7 +169,7 @@ <h3>engine</h3>
<div class="tsd-signature tsd-kind-icon">engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L34">home/runner/work/opine/opine/src/view.ts:34</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L34">home/runner/work/opine/opine/src/view.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -179,7 +179,7 @@ <h3>ext</h3>
<div class="tsd-signature tsd-kind-icon">ext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L31">home/runner/work/opine/opine/src/view.ts:31</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L31">home/runner/work/opine/opine/src/view.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -189,7 +189,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L32">home/runner/work/opine/opine/src/view.ts:32</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L32">home/runner/work/opine/opine/src/view.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -199,7 +199,7 @@ <h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L35">home/runner/work/opine/opine/src/view.ts:35</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L35">home/runner/work/opine/opine/src/view.ts:35</a></li>
</ul>
</aside>
</section>
Expand All @@ -209,7 +209,7 @@ <h3>root</h3>
<div class="tsd-signature tsd-kind-icon">root<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L33">home/runner/work/opine/opine/src/view.ts:33</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L33">home/runner/work/opine/opine/src/view.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -226,7 +226,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> lookup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L119">home/runner/work/opine/opine/src/view.ts:119</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L119">home/runner/work/opine/opine/src/view.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -254,7 +254,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> render</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L141">home/runner/work/opine/opine/src/view.ts:141</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L141">home/runner/work/opine/opine/src/view.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -285,7 +285,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> resolve</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/d99e3dc/src/view.ts#L95">home/runner/work/opine/opine/src/view.ts:95</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/df481ad/src/view.ts#L95">home/runner/work/opine/opine/src/view.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 3e5a855

Please sign in to comment.