Skip to content

Commit

Permalink
docs: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@yourtion
yourtion committed Feb 5, 2024
1 parent 7b9abae commit 5f6f254
Show file tree
Hide file tree
Showing 83 changed files with 12,555 additions and 12,048 deletions.
866 changes: 1 addition & 865 deletions docs/assets/css/main.css
View file

Large diffs are not rendered by default.

7 changes: 0 additions & 7 deletions docs/assets/css/main.css.map
View file

This file was deleted.

Binary file modified docs/assets/images/icons.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/icons@2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 51 additions & 5 deletions docs/assets/js/main.js
View file

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions docs/assets/js/search.js
View file

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/js/search.json
View file

Large diffs are not rendered by default.

296 changes: 116 additions & 180 deletions docs/classes/_agent_.testagent.html
View file

Large diffs are not rendered by default.

704 changes: 325 additions & 379 deletions docs/classes/_schema_.schema.html → docs/classes/_api_.api.html
View file

Large diffs are not rendered by default.

312 changes: 162 additions & 150 deletions docs/classes/_extend_docs_.iapidoc.html
View file

Large diffs are not rendered by default.

245 changes: 109 additions & 136 deletions docs/classes/_extend_test_.iapitest.html
View file

Large diffs are not rendered by default.

1,246 changes: 0 additions & 1,246 deletions docs/classes/_index_.api.html
View file

This file was deleted.

1,813 changes: 1,813 additions & 0 deletions docs/classes/_index_.erest.html
View file

Large diffs are not rendered by default.

237 changes: 111 additions & 126 deletions docs/classes/_manager_error_.errormanager.html
View file

Large diffs are not rendered by default.

167 changes: 63 additions & 104 deletions docs/classes/_manager_manager_.manager.html
View file

Large diffs are not rendered by default.

427 changes: 0 additions & 427 deletions docs/classes/_manager_type_.typemanager.html
View file

This file was deleted.

182 changes: 72 additions & 110 deletions docs/globals.html
View file

Large diffs are not rendered by default.

205 changes: 95 additions & 110 deletions docs/index.html
View file

Large diffs are not rendered by default.

215 changes: 82 additions & 133 deletions docs/interfaces/_agent_.itestagentoption.html
View file

Large diffs are not rendered by default.

336 changes: 336 additions & 0 deletions docs/interfaces/_api_.apicommon.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,336 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>APICommon | erest</title>
<meta name="description" content="Documentation for erest">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">erest</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_api_.html">&quot;api&quot;</a>
</li>
<li>
<a href="_api_.apicommon.html">APICommon</a>
</li>
</ul>
<h1>Interface APICommon&lt;T&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T = <span class="tsd-signature-type">DEFAULT_HANDLER</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">APICommon</span>
<ul class="tsd-hierarchy">
<li>
<a href="_api_.apidefine.html" class="tsd-signature-type">APIDefine</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#handler" class="tsd-kind-icon">handler</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#method" class="tsd-kind-icon">method</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#response" class="tsd-kind-icon">response</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_api_.apicommon.html#title" class="tsd-kind-icon">title</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="description" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L32">api.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="handler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> handler</h3>
<div class="tsd-signature tsd-kind-icon">handler<span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type">T</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L33">api.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="method" class="tsd-anchor"></a>
<h3>method</h3>
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <a href="../modules/_api_.html#support_methods" class="tsd-signature-type">SUPPORT_METHODS</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L29">api.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="path" class="tsd-anchor"></a>
<h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L30">api.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="response" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response</h3>
<div class="tsd-signature tsd-kind-icon">response<span class="tsd-signature-symbol">:</span> <a href="../modules/_api_.html#type_response" class="tsd-signature-type">TYPE_RESPONSE</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L34">api.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/yourtion/node-erest/blob/7b9abae/src/lib/api.ts#L31">api.ts:31</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_agent_.html">&quot;agent&quot;</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_api_.html">&quot;api&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_debug_.html">&quot;debug&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_default_errors_.html">&quot;default/errors&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_default_index_.html">&quot;default/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_extend_docs_.html">&quot;extend/docs&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_extend_test_.html">&quot;extend/test&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_index_.html">&quot;index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_manager_error_.html">&quot;manager/error&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_manager_index_.html">&quot;manager/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_manager_manager_.html">&quot;manager/manager&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_params_.html">&quot;params&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_axios_index_.html">&quot;plugin/generate_<wbr>axios/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_apis_.html">&quot;plugin/generate_<wbr>markdown/apis&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_errors_.html">&quot;plugin/generate_<wbr>markdown/errors&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_index_.html">&quot;plugin/generate_<wbr>markdown/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_schema_.html">&quot;plugin/generate_<wbr>markdown/schema&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_types_.html">&quot;plugin/generate_<wbr>markdown/types&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_markdown_utils_.html">&quot;plugin/generate_<wbr>markdown/utils&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_postman_index_.html">&quot;plugin/generate_<wbr>postman/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_plugin_generate_swagger_index_.html">&quot;plugin/generate_<wbr>swagger/index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_utils_.html">&quot;utils&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="../classes/_api_.api.html" class="tsd-kind-icon">API</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
<a href="_api_.apicommon.html" class="tsd-kind-icon">APICommon</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#handler" class="tsd-kind-icon">handler</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#method" class="tsd-kind-icon">method</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#response" class="tsd-kind-icon">response</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_api_.apicommon.html#title" class="tsd-kind-icon">title</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
<a href="_api_.apidefine.html" class="tsd-kind-icon">APIDefine</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
<a href="_api_.apioption.html" class="tsd-kind-icon">APIOption</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_api_.iexample.html" class="tsd-kind-icon">IExample</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_api_.html#default_handler" class="tsd-kind-icon">DEFAULT_<wbr>HANDLER</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_api_.html#support_methods" class="tsd-kind-icon">SUPPORT_<wbr>METHODS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_api_.html#type_response" class="tsd-kind-icon">TYPE_<wbr>RESPONSE</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/_api_.html#support_method" class="tsd-kind-icon">SUPPORT_<wbr>METHOD</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading

0 comments on commit 5f6f254

Please sign in to comment.