Skip to content

Commit 1034357

Browse files
author
Steve Hobbs
authored
Regenerated docs (#1112)
Merging - verified that coverage is passing by looking directly at the coverage reports.
1 parent ae1ed0a commit 1034357

14 files changed

+70
-27
lines changed

‎docs/Authentication.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ <h5>Parameters:</h5>
499499
<br class="clear">
500500

501501
<footer>
502-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
502+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
503503
</footer>
504504

505505
<script>prettyPrint();</script>

‎docs/Management.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ <h5>Parameters:</h5>
294294
<br class="clear">
295295

296296
<footer>
297-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
297+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
298298
</footer>
299299

300300
<script>prettyPrint();</script>

‎docs/WebAuth.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ <h5>Parameters:</h5>
643643
<br class="clear">
644644

645645
<footer>
646-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
646+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
647647
</footer>
648648

649649
<script>prettyPrint();</script>

‎docs/authentication_db-connection.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ <h1 class="page-title">authentication/db-connection.js</h1>
167167
<br class="clear">
168168

169169
<footer>
170-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
170+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
171171
</footer>
172172

173173
<script>prettyPrint();</script>

‎docs/authentication_index.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,7 @@ <h1 class="page-title">authentication/index.js</h1>
686686
<br class="clear">
687687

688688
<footer>
689-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
689+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
690690
</footer>
691691

692692
<script>prettyPrint();</script>

‎docs/global.html

Lines changed: 55 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ <h4 class="name" id="authorize"><span class="type-signature"></span>authorize<sp
161161

162162
<dt class="tag-source">Source:</dt>
163163
<dd class="tag-source"><ul class="dummy"><li>
164-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line660">line 660</a>
164+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line662">line 662</a>
165165
</li></ul></dd>
166166

167167

@@ -2517,7 +2517,7 @@ <h4 class="name" id="changePassword"><span class="type-signature"></span>changeP
25172517

25182518
<dt class="tag-source">Source:</dt>
25192519
<dd class="tag-source"><ul class="dummy"><li>
2520-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line599">line 599</a>
2520+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line601">line 601</a>
25212521
</li></ul></dd>
25222522

25232523

@@ -2719,7 +2719,7 @@ <h5>Parameters:</h5>
27192719

27202720

27212721

2722-
<h4 class="name" id="checkSession"><span class="type-signature"></span>checkSession<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
2722+
<h4 class="name" id="checkSession"><span class="type-signature"></span>checkSession<span class="signature">(options<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"></span></h4>
27232723

27242724

27252725

@@ -2769,6 +2769,13 @@ <h4 class="name" id="checkSession"><span class="type-signature"></span>checkSess
27692769

27702770

27712771

2772+
<dt class="tag-see">See:</dt>
2773+
<dd class="tag-see">
2774+
<ul>
2775+
<li><a href="https://auth0.com/docs/libraries/auth0js/v9#using-checksession-to-acquire-new-tokens">https://auth0.com/docs/libraries/auth0js/v9#using-checksession-to-acquire-new-tokens</a></li>
2776+
</ul>
2777+
</dd>
2778+
27722779

27732780

27742781
</dl>
@@ -3120,6 +3127,40 @@ <h5>Parameters:</h5>
31203127
</tr>
31213128

31223129

3130+
3131+
<tr>
3132+
3133+
<td class="name"><code>cb</code></td>
3134+
3135+
3136+
<td class="type">
3137+
3138+
3139+
<span class="param-type"><code>checkSessionCallback</code></span>
3140+
3141+
3142+
3143+
</td>
3144+
3145+
3146+
<td class="attributes">
3147+
3148+
3149+
3150+
3151+
3152+
</td>
3153+
3154+
3155+
3156+
3157+
<td class="description last">
3158+
3159+
3160+
</td>
3161+
</tr>
3162+
3163+
31233164
</tbody>
31243165
</table>
31253166

@@ -3190,7 +3231,7 @@ <h4 class="name" id="crossOriginAuthenticationCallback"><span class="type-signat
31903231

31913232
<dt class="tag-source">Source:</dt>
31923233
<dd class="tag-source"><ul class="dummy"><li>
3193-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line841">line 841</a>
3234+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line843">line 843</a>
31943235
</li></ul></dd>
31953236

31963237

@@ -3273,7 +3314,7 @@ <h4 class="name" id="crossOriginVerification"><span class="type-signature"></spa
32733314

32743315
<dt class="tag-source">Source:</dt>
32753316
<dd class="tag-source"><ul class="dummy"><li>
3276-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line851">line 851</a>
3317+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line853">line 853</a>
32773318
</li></ul></dd>
32783319

32793320

@@ -5504,7 +5545,7 @@ <h4 class="name" id="login"><span class="type-signature"></span>login<span class
55045545

55055546
<dt class="tag-source">Source:</dt>
55065547
<dd class="tag-source"><ul class="dummy"><li>
5507-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line746">line 746</a>
5548+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line748">line 748</a>
55085549
</li></ul></dd>
55095550

55105551

@@ -7214,7 +7255,7 @@ <h4 class="name" id="logout"><span class="type-signature"></span>logout<span cla
72147255

72157256
<dt class="tag-source">Source:</dt>
72167257
<dd class="tag-source"><ul class="dummy"><li>
7217-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line860">line 860</a>
7258+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line862">line 862</a>
72187259
</li></ul></dd>
72197260

72207261

@@ -7840,7 +7881,7 @@ <h4 class="name" id="passwordlessLogin"><span class="type-signature"></span>pass
78407881

78417882
<dt class="tag-source">Source:</dt>
78427883
<dd class="tag-source"><ul class="dummy"><li>
7843-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line790">line 790</a>
7884+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line792">line 792</a>
78447885
</li></ul></dd>
78457886

78467887

@@ -8168,7 +8209,7 @@ <h4 class="name" id="passwordlessStart"><span class="type-signature"></span>pass
81688209

81698210
<dt class="tag-source">Source:</dt>
81708211
<dd class="tag-source"><ul class="dummy"><li>
8171-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line613">line 613</a>
8212+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line615">line 615</a>
81728213
</li></ul></dd>
81738214

81748215

@@ -8539,7 +8580,7 @@ <h4 class="name" id="passwordlessVerify"><span class="type-signature"></span>pas
85398580

85408581
<dt class="tag-source">Source:</dt>
85418582
<dd class="tag-source"><ul class="dummy"><li>
8542-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line879">line 879</a>
8583+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line881">line 881</a>
85438584
</li></ul></dd>
85448585

85458586

@@ -10712,7 +10753,7 @@ <h4 class="name" id="signup"><span class="type-signature"></span>signup<span cla
1071210753

1071310754
<dt class="tag-source">Source:</dt>
1071410755
<dd class="tag-source"><ul class="dummy"><li>
10715-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line645">line 645</a>
10756+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line647">line 647</a>
1071610757
</li></ul></dd>
1071710758

1071810759

@@ -10984,7 +11025,7 @@ <h4 class="name" id="signupAndAuthorize"><span class="type-signature"></span>sig
1098411025

1098511026
<dt class="tag-source">Source:</dt>
1098611027
<dd class="tag-source"><ul class="dummy"><li>
10987-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line710">line 710</a>
11028+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line712">line 712</a>
1098811029
</li></ul></dd>
1098911030

1099011031

@@ -13578,7 +13619,7 @@ <h4 class="name" id="crossOriginLoginCallback"><span class="type-signature"></sp
1357813619

1357913620
<dt class="tag-source">Source:</dt>
1358013621
<dd class="tag-source"><ul class="dummy"><li>
13581-
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line741">line 741</a>
13622+
<a href="web-auth_index.js.html">web-auth/index.js</a>, <a href="web-auth_index.js.html#line743">line 743</a>
1358213623
</li></ul></dd>
1358313624

1358413625

@@ -15010,7 +15051,7 @@ <h5>Parameters:</h5>
1501015051
<br class="clear">
1501115052

1501215053
<footer>
15013-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
15054+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
1501415055
</footer>
1501515056

1501615057
<script>prettyPrint();</script>

‎docs/helper_object.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ <h1 class="page-title">helper/object.js</h1>
256256
<br class="clear">
257257

258258
<footer>
259-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
259+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
260260
</footer>
261261

262262
<script>prettyPrint();</script>

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ <h2>License</h2>
241241
<br class="clear">
242242

243243
<footer>
244-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
244+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
245245
</footer>
246246

247247
<script>prettyPrint();</script>

‎docs/management_index.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h1 class="page-title">management/index.js</h1>
221221
<br class="clear">
222222

223223
<footer>
224-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
224+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
225225
</footer>
226226

227227
<script>prettyPrint();</script>

‎docs/web-auth_cross-origin-authentication.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ <h1 class="page-title">web-auth/cross-origin-authentication.js</h1>
209209
<br class="clear">
210210

211211
<footer>
212-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
212+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
213213
</footer>
214214

215215
<script>prettyPrint();</script>

‎docs/web-auth_hosted-pages.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ <h1 class="page-title">web-auth/hosted-pages.js</h1>
193193
<br class="clear">
194194

195195
<footer>
196-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
196+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
197197
</footer>
198198

199199
<script>prettyPrint();</script>

‎docs/web-auth_index.js.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -586,6 +586,8 @@ <h1 class="page-title">web-auth/index.js</h1>
586586
* @param {String} [options.scope] scopes to be requested during Auth. e.g. `openid email`
587587
* @param {String} [options.audience] identifier of the resource server who will consume the access token issued after Auth
588588
* @param {String} [options.timeout] value in milliseconds used to timeout when the `/authorize` call is failing as part of the silent authentication with postmessage enabled due to a configuration.
589+
* @param {checkSessionCallback} cb
590+
* @see {@link https://auth0.com/docs/libraries/auth0js/v9#using-checksession-to-acquire-new-tokens}
589591
*/
590592
WebAuth.prototype.checkSession = function(options, cb) {
591593
var params = objectHelper
@@ -981,7 +983,7 @@ <h1 class="page-title">web-auth/index.js</h1>
981983
<br class="clear">
982984

983985
<footer>
984-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
986+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
985987
</footer>
986988

987989
<script>prettyPrint();</script>

‎docs/web-auth_popup.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ <h1 class="page-title">web-auth/popup.js</h1>
361361
<br class="clear">
362362

363363
<footer>
364-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
364+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
365365
</footer>
366366

367367
<script>prettyPrint();</script>

‎docs/web-auth_redirect.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h1 class="page-title">web-auth/redirect.js</h1>
110110
<br class="clear">
111111

112112
<footer>
113-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 09 2020 09:25:47 GMT+0100 (British Summer Time) using the Minami theme.
113+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Jun 12 2020 14:42:01 GMT+0100 (British Summer Time) using the Minami theme.
114114
</footer>
115115

116116
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)