Skip to content

Commit

Permalink
Use main docs to prepare to merge
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamjmcgrath
adamjmcgrath committed Jul 25, 2023
1 parent 0aa1fe3 commit 7808ce7
Show file tree
Hide file tree
Showing 168 changed files with 1,553 additions and 9,996 deletions.
10 changes: 4 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

The Auth0 Next.js SDK is a library for implementing user authentication in Next.js applications.

> :warning: Please be aware that v3 is currently in [**Beta**](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages). Whilst we encourage you to test the update within your applications, we do not recommend using this version in production yet.
![Release](https://img.shields.io/npm/v/@auth0/nextjs-auth0/beta)
![Release](https://img.shields.io/npm/v/@auth0/nextjs-auth0)
[![Coverage](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=coverage&query=jest.coverageThreshold.global.lines&suffix=%25&url=https%3A%2F%2Fraw.githubusercontent.com%2Fauth0%2Fnextjs-auth0%2Fmain%2Fpackage.json)](https://github.com/auth0/nextjs-auth0/blob/main/package.json#L147)
![Downloads](https://img.shields.io/npm/dw/@auth0/nextjs-auth0/beta)
![Downloads](https://img.shields.io/npm/dw/@auth0/nextjs-auth0)
[![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0/beta)
![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0)

📚 [Documentation](#documentation) - 🚀 [Getting Started](#getting-started)- 💻 [API Reference](#api-reference) - 💬 [Feedback](#feedback)

Expand All @@ -30,7 +28,7 @@ The Auth0 Next.js SDK is a library for implementing user authentication in Next.
Using [npm](https://npmjs.org):

```sh
npm install @auth0/nextjs-auth0@beta
npm install @auth0/nextjs-auth0
```

This library requires Node.js 16 LTS and newer LTS versions.
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

16 changes: 3 additions & 13 deletions docs/classes/client_use_user.RequestError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">RequestError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/3adc5d0/src/client/use-user.tsx#L46">client/use-user.tsx:46</a></li></ul></aside>
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/96d1234/src/client/use-user.tsx#L46">client/use-user.tsx:46</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 @@ -60,14 +60,14 @@ <h5><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-t
<h4 class="tsd-returns-title">Returns <a href="client_use_user.RequestError.html" class="tsd-signature-type tsd-kind-class">RequestError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/3adc5d0/src/client/use-user.tsx#L49">client/use-user.tsx:49</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/96d1234/src/client/use-user.tsx#L49">client/use-user.tsx:49</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">status</span><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/3adc5d0/src/client/use-user.tsx#L47">client/use-user.tsx:47</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/96d1234/src/client/use-user.tsx#L47">client/use-user.tsx:47</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -111,28 +111,18 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../modules/handlers_login.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>handlers/login</span></a></li>
<li><a href="../modules/handlers_logout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>handlers/logout</span></a></li>
<li><a href="../modules/handlers_profile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>handlers/profile</span></a></li>
<li><a href="../modules/handlers_router_helpers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>handlers/router-<wbr/>helpers</span></a></li>
<li><a href="../modules/helpers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>helpers</span></a></li>
<li><a href="../modules/helpers_testing.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>helpers/testing</span></a></li>
<li><a href="../modules/helpers_with_api_auth_required.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>helpers/with-<wbr/>api-<wbr/>auth-<wbr/>required</span></a></li>
<li><a href="../modules/helpers_with_middleware_auth_required.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>helpers/with-<wbr/>middleware-<wbr/>auth-<wbr/>required</span></a></li>
<li><a href="../modules/helpers_with_page_auth_required.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>helpers/with-<wbr/>page-<wbr/>auth-<wbr/>required</span></a></li>
<li><a href="../modules/http.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http</span></a></li>
<li><a href="../modules/http_auth0_next_api_request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>api-<wbr/>request</span></a></li>
<li><a href="../modules/http_auth0_next_api_response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>api-<wbr/>response</span></a></li>
<li><a href="../modules/http_auth0_next_request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>request</span></a></li>
<li><a href="../modules/http_auth0_next_request_cookies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>request-<wbr/>cookies</span></a></li>
<li><a href="../modules/http_auth0_next_response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>response</span></a></li>
<li><a href="../modules/http_auth0_next_response_cookies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>http/auth0-<wbr/>next-<wbr/>response-<wbr/>cookies</span></a></li>
<li><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>index</span></a></li>
<li><a href="../modules/init.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>init</span></a></li>
<li><a href="../modules/session.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session</span></a></li>
<li><a href="../modules/session_get_access_token.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session/get-<wbr/>access-<wbr/>token</span></a></li>
<li><a href="../modules/session_get_session.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session/get-<wbr/>session</span></a></li>
<li><a href="../modules/session_session.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session/session</span></a></li>
<li><a href="../modules/session_touch_session.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session/touch-<wbr/>session</span></a></li>
<li><a href="../modules/session_update_session.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>session/update-<wbr/>session</span></a></li>
<li><a href="../modules/shared.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>shared</span></a></li>
<li><a href="../modules/utils_errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>utils/errors</span></a></li>
<li><a href="../modules/version.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>version</span></a></li></ul></nav></div></div></div>
<div class="overlay"></div></body></html>
Loading

0 comments on commit 7808ce7

Please sign in to comment.