Skip to content

Commit

Permalink
fix docs (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
@luisrudge
luisrudge authored Jun 19, 2019
1 parent d7fdae4 commit ce49809
Show file tree
Hide file tree
Showing 14 changed files with 76 additions and 76 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Make sure this is updated based on the sections included:
From the CDN:

```html
<script src="https://cdn.auth0.com/js/auth0-spa-js/1.0.0-beta.2/auth0-spa-js.production.js"></script>
<script src="https://cdn.auth0.com/js/auth0-spa-js/1.0.0/auth0-spa-js.production.js"></script>
```

Using [npm](https://npmjs.org):
Expand Down
20 changes: 10 additions & 10 deletions docs/classes/auth0client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1033,7 +1033,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L29">Auth0Client.ts:29</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L29">Auth0Client.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1059,7 +1059,7 @@ <h3>get<wbr>IdToken<wbr>Claims</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L172">Auth0Client.ts:172</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L172">Auth0Client.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1090,7 +1090,7 @@ <h3>get<wbr>Token<wbr>Silently</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L285">Auth0Client.ts:285</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L285">Auth0Client.ts:285</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1125,7 +1125,7 @@ <h3>get<wbr>Token<wbr>With<wbr>Popup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L358">Auth0Client.ts:358</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L358">Auth0Client.ts:358</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1159,7 +1159,7 @@ <h3>get<wbr>User</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L152">Auth0Client.ts:152</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L152">Auth0Client.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1191,7 +1191,7 @@ <h3>handle<wbr>Redirect<wbr>Callback</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L227">Auth0Client.ts:227</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L227">Auth0Client.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1216,7 +1216,7 @@ <h3>is<wbr>Authenticated</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L386">Auth0Client.ts:386</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L386">Auth0Client.ts:386</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1240,7 +1240,7 @@ <h3>login<wbr>With<wbr>Popup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L101">Auth0Client.ts:101</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L101">Auth0Client.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1277,7 +1277,7 @@ <h3>login<wbr>With<wbr>Redirect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L194">Auth0Client.ts:194</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L194">Auth0Client.ts:194</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1310,7 +1310,7 @@ <h3>logout</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/Auth0Client.ts#L401">Auth0Client.ts:401</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/Auth0Client.ts#L401">Auth0Client.ts:401</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/authenticationerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1023,7 +1023,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/errors.ts#L1">errors.ts:1</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/errors.ts#L1">errors.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -1051,7 +1051,7 @@ <h3>error</h3>
<div class="tsd-signature tsd-kind-icon">error<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/auth0/auth0-spa-js/blob/b9ae10f/src/errors.ts#L3">errors.ts:3</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/errors.ts#L3">errors.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -1061,7 +1061,7 @@ <h3>error_<wbr>description</h3>
<div class="tsd-signature tsd-kind-icon">error_<wbr>description<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/auth0/auth0-spa-js/blob/b9ae10f/src/errors.ts#L4">errors.ts:4</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/errors.ts#L4">errors.ts:4</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -1105,7 +1105,7 @@ <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/auth0/auth0-spa-js/blob/b9ae10f/src/errors.ts#L5">errors.ts:5</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/errors.ts#L5">errors.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -970,7 +970,7 @@ <h2 id="documentation">Documentation</h2>
</ul>
<h2 id="installation">Installation</h2>
<p>From the CDN:</p>
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.0-beta.2/auth0-spa-js.production.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.0/auth0-spa-js.production.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<p>Using <a href="https://npmjs.org">npm</a>:</p>
<pre><code class="language-sh">npm install @auth0/auth0-spa-js</code></pre>
<p>Using <a href="https://yarnpkg.com">yarn</a>:</p>
Expand Down Expand Up @@ -1124,7 +1124,7 @@ <h3>create<wbr>Auth0<wbr>Client</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/index.ts#L7">index.ts:7</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/index.ts#L7">index.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -970,7 +970,7 @@ <h2 id="documentation">Documentation</h2>
</ul>
<h2 id="installation">Installation</h2>
<p>From the CDN:</p>
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.0-beta.2/auth0-spa-js.production.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.0/auth0-spa-js.production.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<p>Using <a href="https://npmjs.org">npm</a>:</p>
<pre><code class="language-sh">npm install @auth0/auth0-spa-js</code></pre>
<p>Using <a href="https://yarnpkg.com">yarn</a>:</p>
Expand Down Expand Up @@ -1125,7 +1125,7 @@ <h3>create<wbr>Auth0<wbr>Client</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/index.ts#L7">index.ts:7</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/index.ts#L7">index.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
28 changes: 14 additions & 14 deletions docs/interfaces/auth0clientoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> acr_<wbr>values</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.acr_values</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L40">global.ts:40</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L40">global.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -1050,7 +1050,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> audience</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.audience</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L48">global.ts:48</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L48">global.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1065,7 +1065,7 @@ <h3>client_<wbr>id</h3>
<div class="tsd-signature tsd-kind-icon">client_<wbr>id<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/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L67">global.ts:67</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L67">global.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1081,7 +1081,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> connection</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.connection</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L54">global.ts:54</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L54">global.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1099,7 +1099,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> display</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.display</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L11">global.ts:11</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L11">global.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1119,7 +1119,7 @@ <h3>domain</h3>
<div class="tsd-signature tsd-kind-icon">domain<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/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L63">global.ts:63</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L63">global.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1137,7 +1137,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id_<wbr>token_<wbr>hi
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.id_token_hint</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L33">global.ts:33</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L33">global.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1152,7 +1152,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> leeway</h3>
<div class="tsd-signature tsd-kind-icon">leeway<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/auth0-spa-js/blob/b9ae10f/src/global.ts#L80">global.ts:80</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L80">global.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1169,7 +1169,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> login_<wbr>hint</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.login_hint</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L39">global.ts:39</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L39">global.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1187,7 +1187,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr>age</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.max_age</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L24">global.ts:24</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L24">global.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1205,7 +1205,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> prompt</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.prompt</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L18">global.ts:18</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L18">global.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1225,7 +1225,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> redirect_<wbr>uri</h3
<div class="tsd-signature tsd-kind-icon">redirect_<wbr>uri<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/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L75">global.ts:75</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L75">global.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1245,7 +1245,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> scope</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.scope</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L44">global.ts:44</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L44">global.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1261,7 +1261,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ui_<wbr>locales</h3>
<aside class="tsd-sources">
<p>Inherited from BaseLoginOptions.ui_locales</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L29">global.ts:29</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L29">global.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/getidtokenclaimsoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -985,7 +985,7 @@ <h3>audience</h3>
<div class="tsd-signature tsd-kind-icon">audience<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/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L139">global.ts:139</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L139">global.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1000,7 +1000,7 @@ <h3>scope</h3>
<div class="tsd-signature tsd-kind-icon">scope<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/auth0/auth0-spa-js/blob/b9ae10f/src/global.ts#L135">global.ts:135</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d7fdae4/src/global.ts#L135">global.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit ce49809

Please sign in to comment.