Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generated docs #189

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Auto-generated docs #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,660 changes: 2,660 additions & 0 deletions docs/assets/css/main.css
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/assets/images/icons.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/[email protected]
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/widgets.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/[email protected]
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
248 changes: 248 additions & 0 deletions docs/assets/js/main.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/search.js
View file
Open in desktop

Large diffs are not rendered by default.

505 changes: 505 additions & 0 deletions docs/classes/app.App.html
View file
Open in desktop

Large diffs are not rendered by default.

462 changes: 462 additions & 0 deletions docs/classes/authorization_request.AuthorizationRequest.html
View file
Open in desktop

Large diffs are not rendered by default.

353 changes: 353 additions & 0 deletions docs/classes/authorization_request_handler.AuthorizationNotifier.html
View file
Open in desktop

Large diffs are not rendered by default.

488 changes: 488 additions & 0 deletions docs/classes/authorization_request_handler.AuthorizationRequestHandler.html
View file
Open in desktop

Large diffs are not rendered by default.

356 changes: 356 additions & 0 deletions docs/classes/authorization_response.AuthorizationError.html
View file
Open in desktop

Large diffs are not rendered by default.

328 changes: 328 additions & 0 deletions docs/classes/authorization_response.AuthorizationResponse.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,328 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AuthorizationResponse | @openid/appauth</title>
<meta name="description" content="Documentation for @openid/appauth">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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">@openid/appauth</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>
</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">@openid/appauth</a>
</li>
<li>
<a href="../modules/authorization_response.html">authorization_response</a>
</li>
<li>
<a href="authorization_response.AuthorizationResponse.html">AuthorizationResponse</a>
</li>
</ul>
<h1>Class AuthorizationResponse</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Represents the Authorization Response type.
For more information look at
<a href="https://tools.ietf.org/html/rfc6749#section-4.1.2">https://tools.ietf.org/html/rfc6749#section-4.1.2</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AuthorizationResponse</span>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="authorization_response.AuthorizationResponse.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="authorization_response.AuthorizationResponse.html#code" class="tsd-kind-icon">code</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="authorization_response.AuthorizationResponse.html#state" class="tsd-kind-icon">state</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="authorization_response.AuthorizationResponse.html#toJson" class="tsd-kind-icon">to<wbr>Json</a></li>
</ul>
</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">
<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>Authorization<wbr>Response<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><a href="../interfaces/authorization_response.AuthorizationResponseJson.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizationResponseJson</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="authorization_response.AuthorizationResponse.html" class="tsd-signature-type" data-tsd-kind="Class">AuthorizationResponse</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/shadow-light/AppAuth-JS/blob/c30f85e/src/authorization_response.ts#L42">authorization_response.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>response: <a href="../interfaces/authorization_response.AuthorizationResponseJson.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizationResponseJson</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="authorization_response.AuthorizationResponse.html" class="tsd-signature-type" data-tsd-kind="Class">AuthorizationResponse</a></h4>
</li>
</ul>
</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">
<a name="code" class="tsd-anchor"></a>
<h3>code</h3>
<div class="tsd-signature tsd-kind-icon">code<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/shadow-light/AppAuth-JS/blob/c30f85e/src/authorization_response.ts#L39">authorization_response.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="state" class="tsd-anchor"></a>
<h3>state</h3>
<div class="tsd-signature tsd-kind-icon">state<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/shadow-light/AppAuth-JS/blob/c30f85e/src/authorization_response.ts#L40">authorization_response.ts:40</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">
<a name="toJson" class="tsd-anchor"></a>
<h3>to<wbr>Json</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>Json<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/authorization_response.AuthorizationResponseJson.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizationResponseJson</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/shadow-light/AppAuth-JS/blob/c30f85e/src/authorization_response.ts#L47">authorization_response.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/authorization_response.AuthorizationResponseJson.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthorizationResponseJson</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/app.html">app</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/authorization_request.html">authorization_<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/authorization_request_handler.html">authorization_<wbr>request_<wbr>handler</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/authorization_response.html">authorization_<wbr>response</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/authorization_service_configuration.html">authorization_<wbr>service_<wbr>configuration</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/crypto_utils.html">crypto_<wbr>utils</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/errors.html">errors</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/flags.html">flags</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/logger.html">logger</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/node_app.html">node_<wbr>app</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/node_support.html">node_<wbr>support</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/node_support_crypto_utils.html">node_<wbr>support/crypto_<wbr>utils</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/node_support_node_request_handler.html">node_<wbr>support/node_<wbr>request_<wbr>handler</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/node_support_node_requestor.html">node_<wbr>support/node_<wbr>requestor</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/query_string_utils.html">query_<wbr>string_<wbr>utils</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/redirect_based_handler.html">redirect_<wbr>based_<wbr>handler</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/revoke_token_request.html">revoke_<wbr>token_<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/token_request.html">token_<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/token_request_handler.html">token_<wbr>request_<wbr>handler</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/token_response.html">token_<wbr>response</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types.html">types</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/xhr.html">xhr</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="authorization_response.AuthorizationError.html" class="tsd-kind-icon">Authorization<wbr>Error</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="authorization_response.AuthorizationResponse.html" class="tsd-kind-icon">Authorization<wbr>Response</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="authorization_response.AuthorizationResponse.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="authorization_response.AuthorizationResponse.html#code" class="tsd-kind-icon">code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="authorization_response.AuthorizationResponse.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="authorization_response.AuthorizationResponse.html#toJson" class="tsd-kind-icon">to<wbr>Json</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/authorization_response.AuthorizationErrorJson.html" class="tsd-kind-icon">Authorization<wbr>Error<wbr>Json</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/authorization_response.AuthorizationResponseJson.html" class="tsd-kind-icon">Authorization<wbr>Response<wbr>Json</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-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<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-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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