-
Notifications
You must be signed in to change notification settings - Fork 389
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #660 from auth0/release/v1.8.0
Release v1.8.0
- Loading branch information
Showing
42 changed files
with
703 additions
and
154 deletions.
There are no files selected for viewing
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
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,283 @@ | ||
<!doctype html> | ||
<html class="default no-js"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
<title>RequestError | @auth0/nextjs-auth0</title> | ||
<meta name="description" content="Documentation for @auth0/nextjs-auth0"> | ||
<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">@auth0/nextjs-auth0</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> | ||
</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="../index.html">@auth0/nextjs-auth0</a> | ||
</li> | ||
<li> | ||
<a href="../modules/frontend_use_user.html">frontend/use-user</a> | ||
</li> | ||
<li> | ||
<a href="frontend_use_user.requesterror.html">RequestError</a> | ||
</li> | ||
</ul> | ||
<h1>Class RequestError</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>The error thrown by the user fetcher.</p> | ||
</div> | ||
<p>The <code>status</code> property contains the status code of the response. It is <code>0</code> when the request fails, e.g. due to being | ||
offline.</p> | ||
<p>This error is not thrown when the status code of the response is <code>401</code>, because that means the user is not | ||
authenticated.</p> | ||
</div> | ||
</section> | ||
<section class="tsd-panel tsd-hierarchy"> | ||
<h3>Hierarchy</h3> | ||
<ul class="tsd-hierarchy"> | ||
<li> | ||
<span class="tsd-signature-type">Error</span> | ||
<ul class="tsd-hierarchy"> | ||
<li> | ||
<span class="target">RequestError</span> | ||
</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>Constructors</h3> | ||
<ul class="tsd-index-list"> | ||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="frontend_use_user.requesterror.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="frontend_use_user.requesterror.html#status" class="tsd-kind-icon">status</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>Request<wbr>Error<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><span class="tsd-signature-symbol">: </span><a href="frontend_use_user.requesterror.html" class="tsd-signature-type" data-tsd-kind="Class">RequestError</a></li> | ||
</ul> | ||
<ul class="tsd-descriptions"> | ||
<li class="tsd-description"> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</a></li> | ||
</ul> | ||
</aside> | ||
<h4 class="tsd-parameters-title">Parameters</h4> | ||
<ul class="tsd-parameters"> | ||
<li> | ||
<h5>status: <span class="tsd-signature-type">number</span></h5> | ||
</li> | ||
</ul> | ||
<h4 class="tsd-returns-title">Returns <a href="frontend_use_user.requesterror.html" class="tsd-signature-type" data-tsd-kind="Class">RequestError</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="status" class="tsd-anchor"></a> | ||
<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/auth0/nextjs-auth0/blob/8511943/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</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=" "> | ||
<a href="../index.html">Exports</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/config.html">config</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/frontend.html">frontend</a> | ||
</li> | ||
<li class="current tsd-kind-module"> | ||
<a href="../modules/frontend_use_user.html">frontend/use-<wbr>user</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/frontend_with_page_auth_required.html">frontend/with-<wbr>page-<wbr>auth-<wbr>required</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers.html">handlers</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers_auth.html">handlers/auth</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers_callback.html">handlers/callback</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers_login.html">handlers/login</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers_logout.html">handlers/logout</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/handlers_profile.html">handlers/profile</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/helpers.html">helpers</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/helpers_with_api_auth_required.html">helpers/with-<wbr>api-<wbr>auth-<wbr>required</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/helpers_with_page_auth_required.html">helpers/with-<wbr>page-<wbr>auth-<wbr>required</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/instance.html">instance</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/session.html">session</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/session_get_access_token.html">session/get-<wbr>access-<wbr>token</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/session_get_session.html">session/get-<wbr>session</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/session_session.html">session/session</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/utils_errors.html">utils/errors</a> | ||
</li> | ||
<li class=" tsd-kind-module"> | ||
<a href="../modules/version.html">version</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
<nav class="tsd-navigation secondary menu-sticky"> | ||
<ul class="before-current"> | ||
</ul> | ||
<ul class="current"> | ||
<li class="current tsd-kind-class tsd-parent-kind-module"> | ||
<a href="frontend_use_user.requesterror.html" class="tsd-kind-icon">Request<wbr>Error</a> | ||
<ul> | ||
<li class=" tsd-kind-constructor tsd-parent-kind-class"> | ||
<a href="frontend_use_user.requesterror.html#constructor" class="tsd-kind-icon">constructor</a> | ||
</li> | ||
<li class=" tsd-kind-property tsd-parent-kind-class"> | ||
<a href="frontend_use_user.requesterror.html#status" class="tsd-kind-icon">status</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
<ul class="after-current"> | ||
<li class=" tsd-kind-interface tsd-parent-kind-module"> | ||
<a href="../interfaces/frontend_use_user.userprofile.html" class="tsd-kind-icon">User<wbr>Profile</a> | ||
</li> | ||
<li class=" tsd-kind-type-alias tsd-parent-kind-module"> | ||
<a href="../modules/frontend_use_user.html#useuser" class="tsd-kind-icon">Use<wbr>User</a> | ||
</li> | ||
<li class=" tsd-kind-type-alias tsd-parent-kind-module"> | ||
<a href="../modules/frontend_use_user.html#usercontext" class="tsd-kind-icon">User<wbr>Context</a> | ||
</li> | ||
<li class=" tsd-kind-type-alias tsd-parent-kind-module"> | ||
<a href="../modules/frontend_use_user.html#userprovider" class="tsd-kind-icon">User<wbr>Provider</a> | ||
</li> | ||
<li class=" tsd-kind-type-alias tsd-parent-kind-module"> | ||
<a href="../modules/frontend_use_user.html#userproviderprops" class="tsd-kind-icon">User<wbr>Provider<wbr>Props</a> | ||
</li> | ||
<li class=" tsd-kind-property tsd-parent-kind-module"> | ||
<a href="../modules/frontend_use_user.html#default" class="tsd-kind-icon">default</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> | ||
</div> | ||
</div> | ||
<footer> | ||
<div class="container"> | ||
<h2>Legend</h2> | ||
<div class="tsd-legend-group"> | ||
<ul class="tsd-legend"> | ||
<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> | ||
<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-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> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> | ||
</ul> | ||
</div> | ||
</div> | ||
</footer> | ||
<div class="overlay"></div> | ||
<script src="../assets/js/main.js"></script> | ||
</body> | ||
</html> |
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
Oops, something went wrong.