Skip to content

Commit

Permalink
Docs + Logo
Browse files Browse the repository at this point in the history
  • Loading branch information
cabraviva committed Apr 24, 2023
1 parent 8d7fdb3 commit ce79a64
Show file tree
Hide file tree
Showing 22 changed files with 83 additions and 83 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Knorry](/logo.jpg)
![Knorry](https://raw.githubusercontent.com/greencoder001/knorry/main/logo.jpg)

<center align="center">

Expand Down Expand Up @@ -144,4 +144,4 @@ await get('/whoami') instanceof String
!!(await get('/returns-false')).$plain() // -> false
```

If you are working on an enterprise project, you should disable easyMode by default.
If you are working on an enterprise project, you should disable easyMode by default.
2 changes: 1 addition & 1 deletion docs/functions/defineKnorryOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type tsd-kind-interface">RequestOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L770">src/main.ts:770</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L770">src/main.ts:770</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/del.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L642">src/main.ts:642</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L642">src/main.ts:642</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/get.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L620">src/main.ts:620</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L620">src/main.ts:620</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L631">src/main.ts:631</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L631">src/main.ts:631</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/knorry.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L706">src/main.ts:706</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L706">src/main.ts:706</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/options.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L678">src/main.ts:678</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L678">src/main.ts:678</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/patch.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L692">src/main.ts:692</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L692">src/main.ts:692</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/post.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L654">src/main.ts:654</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L654">src/main.ts:654</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/put.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KnorryResponse.html" class="tsd-signature-type tsd-kind-type-alias">KnorryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Promise that resolves either with a primitive type containing the full response as the $res property or undefined</p>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L666">src/main.ts:666</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L666">src/main.ts:666</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<div class="col-content">
<div class="tsd-page-title">
<h2>knorry</h2></div>
<div class="tsd-panel tsd-typography"><p><img src="/logo.jpg" alt="Knorry"></p>
<div class="tsd-panel tsd-typography"><p><img src="https://raw.githubusercontent.com/greencoder001/knorry/main/logo.jpg" alt="Knorry"></p>
<center align="center">

<p><img src="https://img.shields.io/github/actions/workflow/status/greencoder001/knorry/test.yaml?style=flat-square" alt="Test">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/ArrayResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ArrayResponse</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L38">src/main.ts:38</a></li></ul></aside>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L38">src/main.ts:38</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -84,7 +84,7 @@ <h3 class="tsd-anchor-link"><span>$res</span><a href="#_res" aria-label="Permali
<div class="tsd-comment tsd-typography"><p>This will include the complete response without pretending to be a different type</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L42">src/main.ts:42</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L42">src/main.ts:42</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_unscopables_" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>[unscopables]</span><a href="#_unscopables_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">[unscopables]</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>聽聽聽聽</span><span class="tsd-kind-property">[unscopables]</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">[iterator]</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">at</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">concat</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">copyWithin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">entries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">every</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">fill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">filter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">find</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">findIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">findLast</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">findLastIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">flat</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">flatMap</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">forEach</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">includes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">indexOf</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">join</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">keys</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">lastIndexOf</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">map</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">pop</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">push</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">reduce</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">reduceRight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">reverse</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">shift</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">slice</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">some</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">splice</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">toLocaleString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">toString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">unshift</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>聽聽聽聽</span><span class="tsd-kind-method">values</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
Expand Down Expand Up @@ -125,7 +125,7 @@ <h3 class="tsd-anchor-link"><span>$plain</span><a href="#_plain" aria-label="Per
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/a653351/src/main.ts#L46">src/main.ts:46</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/greencoder001/knorry/blob/8d7fdb3/src/main.ts#L46">src/main.ts:46</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_iterator_-1" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>[iterator]</span><a href="#_iterator_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
Expand Down
Loading

0 comments on commit ce79a64

Please sign in to comment.