This repository has been archived by the owner on Dec 24, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
38 changed files
with
12,367 additions
and
1 deletion.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,330 @@ | ||
<!doctype html> | ||
<html class="default no-js"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
<title>AbortController | @augu/orchid</title> | ||
<meta name="description" content=""> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
<link href="https://fonts.googleapis.com/css?family=Noto+Sans&display=swap" rel="stylesheet"> | ||
<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.js" 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">@augu/orchid</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="../modules.html">Globals</a> | ||
</li> | ||
<li> | ||
<a href="../modules/core_abortcontroller.html">core/AbortController</a> | ||
</li> | ||
<li> | ||
<a href="core_abortcontroller.abortcontroller.html">AbortController</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</div> | ||
</header> | ||
<div class="container"> | ||
<div class="row container container-main"> | ||
<div class="col-3 col-menu menu-sticky-wrap menu-highlight"> | ||
<nav class="tsd-navigation secondary menu-sticky"> | ||
<ul> | ||
<ul class="before-current"> | ||
</ul> | ||
<ul class="current"> | ||
<li class="current tsd-kind-class tsd-parent-kind-module"> | ||
<a href="core_abortcontroller.abortcontroller.html" class="tsd-kind-icon">Abort<wbr>Controller</a> | ||
<ul> | ||
<li class=" tsd-kind-constructor tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#constructor" class="tsd-kind-icon">constructor</a> | ||
</li> | ||
<li class=" tsd-kind-property tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#signal" class="tsd-kind-icon">signal</a> | ||
</li> | ||
<li class=" tsd-kind-get-signature tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a> | ||
</li> | ||
<li class=" tsd-kind-method tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#abort" class="tsd-kind-icon">abort</a> | ||
</li> | ||
<li class=" tsd-kind-method tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#tostring" class="tsd-kind-icon">to<wbr>String</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
<ul class="after-current"> | ||
<li class=" tsd-kind-class tsd-parent-kind-module"> | ||
<a href="core_abortcontroller.abortsignal.html" class="tsd-kind-icon">Abort<wbr>Signal</a> | ||
</li> | ||
</ul> | ||
</ul> | ||
<ul> | ||
<li>📑 Index</li> | ||
<li><br></li> | ||
<li class=" "> | ||
<a href="../modules.html">Exports</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/httpclient.html">Http<wbr>Client</a> | ||
</li> <li class="current tsd-kind-module"> | ||
<a href="../modules/core_abortcontroller.html">core/<wbr>Abort<wbr>Controller</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/core_middleware.html">core/<wbr>Middleware</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/core_request.html">core/<wbr>Request</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/core_response.html">core/<wbr>Response</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/core_serializer.html">core/<wbr>Serializer</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/index.html">index</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/middleware.html">middleware</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/middleware_logging.html">middleware/logging</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/middleware_timer.html">middleware/timer</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/serializers_jsonserializer.html">serializers/<wbr>Json<wbr>Serializer</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/serializers_textserializer.html">serializers/<wbr>Text<wbr>Serializer</a> | ||
</li> <li class=" tsd-kind-module"> | ||
<a href="../modules/utils.html">utils</a> | ||
</li> </ul> | ||
</nav> | ||
</div> | ||
<div class="col-9 col-content"> | ||
<section class="tsd-panel tsd-comment"> | ||
<div class="tsd-comment"> | ||
<div class="lead"> | ||
<p>Polyfill for AbortController specified here: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController">https://developer.mozilla.org/en-US/docs/Web/API/AbortController</a></p> | ||
</div> | ||
<p>I made my own polyfill to not add over-head polyfill dependencies</p> | ||
</div> | ||
</section> | ||
<section class="tsd-panel tsd-hierarchy"> | ||
<h3>Hierarchy</h3> | ||
<ul class="tsd-hierarchy"> | ||
<li> | ||
<span class="target">AbortController</span> | ||
</li> | ||
</ul> | ||
</section> | ||
<section class="tsd-panel-group tsd-index-group"> | ||
<section class="tsd-panel tsd-index-panel"> | ||
<div class="tsd-index-content"> | ||
<section class="tsd-index-section "> | ||
<h3>Constructors</h3> | ||
<div class="tsd-navigation secondary"> | ||
<ul> | ||
<li class="tsd-kind-constructor tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#constructor" class="tsd-kind-icon">constructor</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</section> | ||
<section class="tsd-index-section "> | ||
<h3>Properties</h3> | ||
<div class="tsd-navigation secondary"> | ||
<ul> | ||
<li class="tsd-kind-property tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#signal" class="tsd-kind-icon">signal</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</section> | ||
<section class="tsd-index-section "> | ||
<h3>Accessors</h3> | ||
<div class="tsd-navigation secondary"> | ||
<ul> | ||
<li class="tsd-kind-get-signature tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</section> | ||
<section class="tsd-index-section "> | ||
<h3>Methods</h3> | ||
<div class="tsd-navigation secondary"> | ||
<ul> | ||
<li class="tsd-kind-method tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#abort" class="tsd-kind-icon">abort</a> | ||
</li> | ||
</ul> | ||
</div> | ||
<div class="tsd-navigation secondary"> | ||
<ul> | ||
<li class="tsd-kind-method tsd-parent-kind-class"> | ||
<a href="core_abortcontroller.abortcontroller.html#tostring" class="tsd-kind-icon">to<wbr>String</a> | ||
</li> | ||
</ul> | ||
</div> | ||
</section> | ||
</div> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Constructors</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-descriptions"> | ||
<a name="constructor" class="tsd-anchor"></a> | ||
<h3>constructor</h3> | ||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon">new <wbr>Abort<wbr>Controller<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_abortcontroller.abortcontroller.html" class="tsd-signature-type">AbortController</a></li> | ||
</ul> | ||
<h4 class="tsd-returns-title">Returns <a href="core_abortcontroller.abortcontroller.html" class="tsd-signature-type">AbortController</a></h4> | ||
</ul> | ||
<aside class="tsd-sources"> | ||
</aside> | ||
</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-class tsd-descriptions"> | ||
<a name="signal" class="tsd-anchor"></a> | ||
<h3>signal</h3> | ||
<div class="tsd-signature tsd-kind-icon">signal<span class="tsd-signature-symbol">:</span> <a href="core_abortcontroller.abortsignal.html" class="tsd-signature-type">AbortSignal</a><span class="tsd-signature-symbol"> = ...</span></div> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/auguwu/orchid/blob/e68927f/src/core/AbortController.ts#L107">core/AbortController.ts:107</a></li> | ||
</ul> | ||
</aside> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Accessors</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-descriptions"> | ||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a> | ||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3> | ||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> | ||
</ul> | ||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> </h4> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/auguwu/orchid/blob/e68927f/src/core/AbortController.ts#L127">core/AbortController.ts:127</a></li> | ||
</ul> | ||
</aside> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Methods</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-descriptions"> | ||
<a name="abort" class="tsd-anchor"></a> | ||
<h3>abort</h3> | ||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon">abort<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> | ||
</ul> | ||
<div class="tsd-comment"> | ||
<div class="lead"> | ||
<p>Aborts the request</p> | ||
</div> | ||
</div> | ||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span> </h4> | ||
</ul> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/auguwu/orchid/blob/e68927f/src/core/AbortController.ts#L112">core/AbortController.ts:112</a></li> | ||
</ul> | ||
</aside> | ||
</section> | ||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-descriptions"> | ||
<a name="tostring" class="tsd-anchor"></a> | ||
<h3>to<wbr>String</h3> | ||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> | ||
</ul> | ||
<div class="tsd-comment"> | ||
<div class="lead"> | ||
<p>Returns a string representation of this object</p> | ||
</div> | ||
</div> | ||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> </h4> | ||
</ul> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/auguwu/orchid/blob/e68927f/src/core/AbortController.ts#L123">core/AbortController.ts:123</a></li> | ||
</ul> | ||
</aside> | ||
</section> | ||
</section> | ||
<footer class="with-border-bottom"> | ||
<div class="tsd-legend-group"> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-is-inherited"><span class="tsd-kind-icon">Inherited</span></li> | ||
<li class="tsd-is-protected"><span class="tsd-kind-icon">Protected</span></li> | ||
<li class="tsd-is-private"><span class="tsd-kind-icon">Private</span></li> | ||
<li class="tsd-is-static"><span class="tsd-kind-icon">Static</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> | ||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object</span></li> | ||
<li class="tsd-kind-property"><span class="tsd-kind-icon">Property</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> | ||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type</span></li> | ||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> | ||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enum</span></li> | ||
<li class="tsd-kind-constructor"><span class="tsd-kind-icon">Constructor</span></li> | ||
<li class="tsd-kind-accessor"><span class="tsd-kind-icon">Getter/Setter</span></li> | ||
</ul> | ||
</div> | ||
</footer> | ||
<div>Made with ❤️ by <a href="https://github.com/pirix-gh/eledoc" target="_blank">pirix-gh</a>. Documentation generated by <a href="http://typedoc.org/" target="_blank">TypeDoc.</a></div> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="overlay"></div> | ||
<script src="../assets/js/main.js"></script> | ||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> | ||
</body> | ||
</html> |
Oops, something went wrong.