Skip to content

Commit 5717ccf

Browse files
acwestacwest
committed
add docs
1 parent 8fe2fb6 commit 5717ccf

File tree

1,500 files changed

+5723
-5719
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,500 files changed

+5723
-5719
lines changed

‎docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/auth.AuthApiError.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
2323
<ul class="tsd-hierarchy">
2424
<li><span class="target">AuthApiError</span></li></ul></li></ul></section><aside class="tsd-sources">
2525
<ul>
26-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside>
26+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside>
2727
<section class="tsd-panel-group tsd-index-group">
2828
<section class="tsd-panel tsd-index-panel">
2929
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,29 +73,29 @@ <h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-
7373
<h4 class="tsd-returns-title">Returns <a href="auth.AuthApiError.html" class="tsd-signature-type tsd-kind-class">AuthApiError</a></h4><aside class="tsd-sources">
7474
<p>Overrides Error.constructor</p>
7575
<ul>
76-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></li></ul></section></section>
76+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></li></ul></section></section>
7777
<section class="tsd-panel-group tsd-member-group">
7878
<h2>Properties</h2>
7979
<section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a>
8080
<h3 class="tsd-anchor-link"><span>body</span><a href="#body" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8181
<div class="tsd-signature"><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
8282
<ul>
83-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
83+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
8484
<section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
8585
<h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8686
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
8787
<ul>
88-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
88+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
8989
<section class="tsd-panel tsd-member"><a id="error_description" class="tsd-anchor"></a>
9090
<h3 class="tsd-anchor-link"><span>error_<wbr/>description</span><a href="#error_description" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
9191
<div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
9292
<ul>
93-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
93+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
9494
<section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
9595
<h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
9696
<div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Headers</span></div><aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L40">src/auth/base-auth-api.ts:40</a></li></ul></aside></section>
98+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L40">src/auth/base-auth-api.ts:40</a></li></ul></aside></section>
9999
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
100100
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
101101
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -107,7 +107,7 @@ <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permali
107107
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AuthApiError&quot;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
108108
<p>Overrides Error.name</p>
109109
<ul>
110-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></section>
110+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></section>
111111
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
112112
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
113113
<div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -118,7 +118,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
118118
<h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
119119
<div class="tsd-signature"><span class="tsd-kind-property">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
121+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
122122
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
123123
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
124124
<div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>

‎docs/classes/auth.AuthenticationClient.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">AuthenticationClient</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L13">src/auth/index.ts:13</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L13">src/auth/index.ts:13</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -52,29 +52,29 @@ <h4 class="tsd-parameters-title">Parameters</h4>
5252
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.AuthenticationClientOptions.html" class="tsd-signature-type tsd-kind-interface">AuthenticationClientOptions</a></h5></li></ul></div>
5353
<h4 class="tsd-returns-title">Returns <a href="auth.AuthenticationClient.html" class="tsd-signature-type tsd-kind-class">AuthenticationClient</a></h4><aside class="tsd-sources">
5454
<ul>
55-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L19">src/auth/index.ts:19</a></li></ul></aside></li></ul></section></section>
55+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L19">src/auth/index.ts:19</a></li></ul></aside></li></ul></section></section>
5656
<section class="tsd-panel-group tsd-member-group">
5757
<h2>Properties</h2>
5858
<section class="tsd-panel tsd-member"><a id="backchannel" class="tsd-anchor"></a>
5959
<h3 class="tsd-anchor-link"><span>backchannel</span><a href="#backchannel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
6060
<div class="tsd-signature"><span class="tsd-kind-property">backchannel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Backchannel</span></div><aside class="tsd-sources">
6161
<ul>
62-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L17">src/auth/index.ts:17</a></li></ul></aside></section>
62+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L17">src/auth/index.ts:17</a></li></ul></aside></section>
6363
<section class="tsd-panel tsd-member"><a id="database" class="tsd-anchor"></a>
6464
<h3 class="tsd-anchor-link"><span>database</span><a href="#database" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
6565
<div class="tsd-signature"><span class="tsd-kind-property">database</span><span class="tsd-signature-symbol">:</span> <a href="auth.Database.html" class="tsd-signature-type tsd-kind-class">Database</a></div><aside class="tsd-sources">
6666
<ul>
67-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L14">src/auth/index.ts:14</a></li></ul></aside></section>
67+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L14">src/auth/index.ts:14</a></li></ul></aside></section>
6868
<section class="tsd-panel tsd-member"><a id="oauth" class="tsd-anchor"></a>
6969
<h3 class="tsd-anchor-link"><span>oauth</span><a href="#oauth" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
7070
<div class="tsd-signature"><span class="tsd-kind-property">oauth</span><span class="tsd-signature-symbol">:</span> <a href="auth.OAuth.html" class="tsd-signature-type tsd-kind-class">OAuth</a></div><aside class="tsd-sources">
7171
<ul>
72-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L15">src/auth/index.ts:15</a></li></ul></aside></section>
72+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L15">src/auth/index.ts:15</a></li></ul></aside></section>
7373
<section class="tsd-panel tsd-member"><a id="passwordless" class="tsd-anchor"></a>
7474
<h3 class="tsd-anchor-link"><span>passwordless</span><a href="#passwordless" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
7575
<div class="tsd-signature"><span class="tsd-kind-property">passwordless</span><span class="tsd-signature-symbol">:</span> <a href="auth.Passwordless.html" class="tsd-signature-type tsd-kind-class">Passwordless</a></div><aside class="tsd-sources">
7676
<ul>
77-
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/62e1890b/src/auth/index.ts#L16">src/auth/index.ts:16</a></li></ul></aside></section></section></div>
77+
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/8fe2fb69/src/auth/index.ts#L16">src/auth/index.ts:16</a></li></ul></aside></section></section></div>
7878
<div class="col-sidebar">
7979
<div class="page-menu">
8080
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)