@inrupt/solid-client-authn-browser 1.11.9-alpha.1 → 1.11.9-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. package/dist/index.es.js +4 -352
  2. package/dist/index.es.js.map +1 -0
  3. package/dist/index.js +12 -360
  4. package/dist/index.js.map +1 -1
  5. package/dist/solid-client-authn.bundle.js +14 -363
  6. package/dist/solid-client-authn.bundle.js.map +1 -0
  7. package/package.json +8 -5
  8. package/.eslintrc.js +0 -16
  9. package/NOTICE +0 -5
  10. package/coverage/clover.xml +0 -547
  11. package/coverage/coverage-final.json +0 -28
  12. package/coverage/lcov-report/base.css +0 -224
  13. package/coverage/lcov-report/block-navigation.js +0 -87
  14. package/coverage/lcov-report/favicon.png +0 -0
  15. package/coverage/lcov-report/index.html +0 -266
  16. package/coverage/lcov-report/prettify.css +0 -1
  17. package/coverage/lcov-report/prettify.js +0 -2
  18. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  19. package/coverage/lcov-report/sorter.js +0 -196
  20. package/coverage/lcov-report/src/ClientAuthentication.ts.html +0 -631
  21. package/coverage/lcov-report/src/Session.ts.html +0 -1435
  22. package/coverage/lcov-report/src/constant.ts.html +0 -163
  23. package/coverage/lcov-report/src/defaultSession.ts.html +0 -460
  24. package/coverage/lcov-report/src/dependencies.ts.html +0 -400
  25. package/coverage/lcov-report/src/iframe.ts.html +0 -394
  26. package/coverage/lcov-report/src/index.browser.ts.html +0 -157
  27. package/coverage/lcov-report/src/index.html +0 -206
  28. package/coverage/lcov-report/src/login/AggregateLoginHandler.ts.html +0 -226
  29. package/coverage/lcov-report/src/login/index.html +0 -116
  30. package/coverage/lcov-report/src/login/oidc/AggregateOidcHandler.ts.html +0 -226
  31. package/coverage/lcov-report/src/login/oidc/ClientRegistrar.ts.html +0 -415
  32. package/coverage/lcov-report/src/login/oidc/IssuerConfigFetcher.ts.html +0 -646
  33. package/coverage/lcov-report/src/login/oidc/OidcLoginHandler.ts.html +0 -436
  34. package/coverage/lcov-report/src/login/oidc/Redirector.ts.html +0 -229
  35. package/coverage/lcov-report/src/login/oidc/index.html +0 -176
  36. package/coverage/lcov-report/src/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.ts.html +0 -478
  37. package/coverage/lcov-report/src/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.ts.html +0 -319
  38. package/coverage/lcov-report/src/login/oidc/oidcHandlers/index.html +0 -131
  39. package/coverage/lcov-report/src/login/oidc/redirectHandler/AggregateRedirectHandler.ts.html +0 -226
  40. package/coverage/lcov-report/src/login/oidc/redirectHandler/AuthCodeRedirectHandler.ts.html +0 -667
  41. package/coverage/lcov-report/src/login/oidc/redirectHandler/ErrorOidcHandler.ts.html +0 -283
  42. package/coverage/lcov-report/src/login/oidc/redirectHandler/FallbackRedirectHandler.ts.html +0 -265
  43. package/coverage/lcov-report/src/login/oidc/redirectHandler/index.html +0 -161
  44. package/coverage/lcov-report/src/login/oidc/refresh/TokenRefresher.ts.html +0 -385
  45. package/coverage/lcov-report/src/login/oidc/refresh/index.html +0 -116
  46. package/coverage/lcov-report/src/login/webid/WebIdLoginHandler.ts.html +0 -250
  47. package/coverage/lcov-report/src/login/webid/index.html +0 -116
  48. package/coverage/lcov-report/src/logout/GeneralLogoutHandler.ts.html +0 -220
  49. package/coverage/lcov-report/src/logout/index.html +0 -116
  50. package/coverage/lcov-report/src/sessionInfo/SessionInfoManager.ts.html +0 -775
  51. package/coverage/lcov-report/src/sessionInfo/index.html +0 -116
  52. package/coverage/lcov-report/src/storage/BrowserStorage.ts.html +0 -229
  53. package/coverage/lcov-report/src/storage/StorageUtility.ts.html +0 -214
  54. package/coverage/lcov-report/src/storage/index.html +0 -131
  55. package/coverage/lcov-report/src/util/UuidGenerator.ts.html +0 -226
  56. package/coverage/lcov-report/src/util/index.html +0 -131
  57. package/coverage/lcov-report/src/util/urlPath.ts.html +0 -208
  58. package/coverage/lcov.info +0 -1001
  59. package/dist/ClientAuthentication.js +0 -64
  60. package/dist/ClientAuthentication.js.map +0 -1
  61. package/dist/Session.js +0 -165
  62. package/dist/Session.js.map +0 -1
  63. package/dist/constant.js +0 -7
  64. package/dist/constant.js.map +0 -1
  65. package/dist/defaultSession.js +0 -48
  66. package/dist/defaultSession.js.map +0 -1
  67. package/dist/dependencies.js +0 -41
  68. package/dist/dependencies.js.map +0 -1
  69. package/dist/iframe.js +0 -43
  70. package/dist/iframe.js.map +0 -1
  71. package/dist/index.browser.d.ts +0 -1
  72. package/dist/index.browser.js +0 -28
  73. package/dist/index.browser.js.map +0 -1
  74. package/dist/login/AggregateLoginHandler.js +0 -10
  75. package/dist/login/AggregateLoginHandler.js.map +0 -1
  76. package/dist/login/oidc/AggregateOidcHandler.js +0 -10
  77. package/dist/login/oidc/AggregateOidcHandler.js.map +0 -1
  78. package/dist/login/oidc/ClientRegistrar.js +0 -51
  79. package/dist/login/oidc/ClientRegistrar.js.map +0 -1
  80. package/dist/login/oidc/IssuerConfigFetcher.js +0 -124
  81. package/dist/login/oidc/IssuerConfigFetcher.js.map +0 -1
  82. package/dist/login/oidc/OidcLoginHandler.js +0 -40
  83. package/dist/login/oidc/OidcLoginHandler.js.map +0 -1
  84. package/dist/login/oidc/Redirector.js +0 -21
  85. package/dist/login/oidc/Redirector.js.map +0 -1
  86. package/dist/login/oidc/__mocks__/IOidcOptions.d.ts +0 -2
  87. package/dist/login/oidc/__mocks__/IOidcOptions.js +0 -25
  88. package/dist/login/oidc/__mocks__/IOidcOptions.js.map +0 -1
  89. package/dist/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.js +0 -56
  90. package/dist/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.js.map +0 -1
  91. package/dist/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.js +0 -47
  92. package/dist/login/oidc/oidcHandlers/OidcHandlerCanHandleTest.js.map +0 -1
  93. package/dist/login/oidc/redirectHandler/AggregateRedirectHandler.js +0 -10
  94. package/dist/login/oidc/redirectHandler/AggregateRedirectHandler.js.map +0 -1
  95. package/dist/login/oidc/redirectHandler/AuthCodeRedirectHandler.js +0 -92
  96. package/dist/login/oidc/redirectHandler/AuthCodeRedirectHandler.js.map +0 -1
  97. package/dist/login/oidc/redirectHandler/ErrorOidcHandler.js +0 -26
  98. package/dist/login/oidc/redirectHandler/ErrorOidcHandler.js.map +0 -1
  99. package/dist/login/oidc/redirectHandler/FallbackRedirectHandler.js +0 -20
  100. package/dist/login/oidc/redirectHandler/FallbackRedirectHandler.js.map +0 -1
  101. package/dist/login/oidc/refresh/TokenRefresher.js +0 -31
  102. package/dist/login/oidc/refresh/TokenRefresher.js.map +0 -1
  103. package/dist/login/webid/WebIdLoginHandler.js +0 -12
  104. package/dist/login/webid/WebIdLoginHandler.js.map +0 -1
  105. package/dist/logout/GeneralLogoutHandler.js +0 -15
  106. package/dist/logout/GeneralLogoutHandler.js.map +0 -1
  107. package/dist/sessionInfo/SessionInfoManager.js +0 -95
  108. package/dist/sessionInfo/SessionInfoManager.js.map +0 -1
  109. package/dist/solid-client-authn.bundle.js.LICENSE.txt +0 -17
  110. package/dist/storage/BrowserStorage.js +0 -18
  111. package/dist/storage/BrowserStorage.js.map +0 -1
  112. package/dist/storage/StorageUtility.js +0 -10
  113. package/dist/storage/StorageUtility.js.map +0 -1
  114. package/dist/util/UuidGenerator.js +0 -10
  115. package/dist/util/UuidGenerator.js.map +0 -1
  116. package/dist/util/urlPath.js +0 -11
  117. package/dist/util/urlPath.js.map +0 -1
  118. package/docs/api/Makefile +0 -76
  119. package/docs/api/README.md +0 -46
  120. package/docs/api/build/docs-assets/README.md +0 -183
  121. package/docs/api/build/docs-assets/_static/css/inrupt.css +0 -349
  122. package/docs/api/build/docs-assets/_templates/breadcrumb-navigation.html +0 -10
  123. package/docs/api/build/docs-assets/_templates/copyright.html +0 -3
  124. package/docs/api/build/docs-assets/_templates/docs-sidebar.html +0 -32
  125. package/docs/api/build/docs-assets/_templates/docs-version-selector.html +0 -21
  126. package/docs/api/build/docs-assets/_templates/jira-feedback.html +0 -21
  127. package/docs/api/build/docs-assets/_templates/layout.html +0 -34
  128. package/docs/api/build/docs-assets/_templates/matomo.html +0 -18
  129. package/docs/api/build/docs-assets/_templates/navbar-logo.html +0 -5
  130. package/docs/api/build/docs-assets/_templates/navbar-nav.html +0 -44
  131. package/docs/api/build/docs-assets/_templates/prev-next.html +0 -19
  132. package/docs/api/build/docs-assets/_templates/versioned-canonical.html +0 -8
  133. package/docs/api/build/docs-assets/themes/inrupt/theme.conf +0 -18
  134. package/docs/api/build/doctrees/classes/ConfigurationError.doctree +0 -0
  135. package/docs/api/build/doctrees/classes/InMemoryStorage.doctree +0 -0
  136. package/docs/api/build/doctrees/classes/NotImplementedError.doctree +0 -0
  137. package/docs/api/build/doctrees/classes/Session.doctree +0 -0
  138. package/docs/api/build/doctrees/environment.pickle +0 -0
  139. package/docs/api/build/doctrees/functions.doctree +0 -0
  140. package/docs/api/build/doctrees/index.doctree +0 -0
  141. package/docs/api/build/doctrees/interfaces/ILoginInputOptions.doctree +0 -0
  142. package/docs/api/build/doctrees/interfaces/ISessionInfo.doctree +0 -0
  143. package/docs/api/build/doctrees/interfaces/ISessionOptions.doctree +0 -0
  144. package/docs/api/build/doctrees/interfaces/IStorage.doctree +0 -0
  145. package/docs/api/build/html/.buildinfo +0 -4
  146. package/docs/api/build/html/_static/basic.css +0 -905
  147. package/docs/api/build/html/_static/css/blank.css +0 -2
  148. package/docs/api/build/html/_static/css/index.ff1ffe594081f20da1ef19478df9384b.css +0 -6
  149. package/docs/api/build/html/_static/css/inrupt.css +0 -349
  150. package/docs/api/build/html/_static/css/theme.css +0 -120
  151. package/docs/api/build/html/_static/doctools.js +0 -323
  152. package/docs/api/build/html/_static/documentation_options.js +0 -12
  153. package/docs/api/build/html/_static/file.png +0 -0
  154. package/docs/api/build/html/_static/jquery-3.5.1.js +0 -10872
  155. package/docs/api/build/html/_static/jquery.js +0 -2
  156. package/docs/api/build/html/_static/js/index.be7d3bbb2ef33a8344ce.js +0 -32
  157. package/docs/api/build/html/_static/language_data.js +0 -297
  158. package/docs/api/build/html/_static/minus.png +0 -0
  159. package/docs/api/build/html/_static/plus.png +0 -0
  160. package/docs/api/build/html/_static/pygments.css +0 -74
  161. package/docs/api/build/html/_static/searchtools.js +0 -529
  162. package/docs/api/build/html/_static/underscore-1.13.1.js +0 -2042
  163. package/docs/api/build/html/_static/underscore.js +0 -6
  164. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/LICENSE.txt +0 -34
  165. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/css/all.min.css +0 -5
  166. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.eot +0 -0
  167. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.svg +0 -3570
  168. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.ttf +0 -0
  169. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff +0 -0
  170. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2 +0 -0
  171. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.eot +0 -0
  172. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.svg +0 -803
  173. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.ttf +0 -0
  174. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff +0 -0
  175. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-regular-400.woff2 +0 -0
  176. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.eot +0 -0
  177. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.svg +0 -4938
  178. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.ttf +0 -0
  179. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff +0 -0
  180. package/docs/api/build/html/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2 +0 -0
  181. package/docs/api/build/html/_static/webpack-macros.html +0 -25
  182. package/docs/api/build/html/classes/ConfigurationError.html +0 -726
  183. package/docs/api/build/html/classes/InMemoryStorage.html +0 -636
  184. package/docs/api/build/html/classes/NotImplementedError.html +0 -726
  185. package/docs/api/build/html/classes/Session.html +0 -2428
  186. package/docs/api/build/html/functions.html +0 -834
  187. package/docs/api/build/html/genindex.html +0 -311
  188. package/docs/api/build/html/index.html +0 -342
  189. package/docs/api/build/html/interfaces/ILoginInputOptions.html +0 -595
  190. package/docs/api/build/html/interfaces/ISessionInfo.html +0 -481
  191. package/docs/api/build/html/interfaces/ISessionOptions.html +0 -463
  192. package/docs/api/build/html/interfaces/IStorage.html +0 -531
  193. package/docs/api/build/html/objects.inv +0 -0
  194. package/docs/api/build/html/search.html +0 -340
  195. package/docs/api/build/html/searchindex.js +0 -1
  196. package/docs/api/build/source/classes/ConfigurationError.md +0 -159
  197. package/docs/api/build/source/classes/InMemoryStorage.md +0 -112
  198. package/docs/api/build/source/classes/NotImplementedError.md +0 -159
  199. package/docs/api/build/source/classes/Session.md +0 -907
  200. package/docs/api/build/source/functions.md +0 -235
  201. package/docs/api/build/source/index.rst +0 -13
  202. package/docs/api/build/source/interfaces/ILoginInputOptions.md +0 -109
  203. package/docs/api/build/source/interfaces/ISessionInfo.md +0 -63
  204. package/docs/api/build/source/interfaces/ISessionOptions.md +0 -60
  205. package/docs/api/build/source/interfaces/IStorage.md +0 -76
  206. package/docs/api/conf.py +0 -135
  207. package/docs/api/redirects.txt +0 -41
  208. package/docs/api/requirements.txt +0 -5
  209. package/docs/api/source/api/.nojekyll +0 -1
  210. package/docs/api/source/api/classes/ConfigurationError.md +0 -163
  211. package/docs/api/source/api/classes/InMemoryStorage.md +0 -112
  212. package/docs/api/source/api/classes/NotImplementedError.md +0 -163
  213. package/docs/api/source/api/classes/Session.md +0 -1426
  214. package/docs/api/source/api/index.md +0 -251
  215. package/docs/api/source/api/interfaces/ILoginInputOptions.md +0 -109
  216. package/docs/api/source/api/interfaces/ISessionInfo.md +0 -63
  217. package/docs/api/source/api/interfaces/ISessionOptions.md +0 -60
  218. package/docs/api/source/api/interfaces/IStorage.md +0 -76
  219. package/docs/api/source/functions.md +0 -3
  220. package/docs/api/source/index.rst +0 -13
  221. package/examples/demoAuthentiationMonitor/index.js +0 -34
  222. package/examples/demoAuthentiationMonitor/package-lock.json +0 -916
  223. package/examples/demoAuthentiationMonitor/package.json +0 -15
  224. package/examples/demoClientApp/.babelrc +0 -3
  225. package/examples/demoClientApp/package-lock.json +0 -11710
  226. package/examples/demoClientApp/package.json +0 -37
  227. package/examples/demoClientApp/src/DemoClientApp.js +0 -686
  228. package/examples/demoClientApp/src/index.html +0 -142
  229. package/examples/demoClientApp/src/index.js +0 -26
  230. package/examples/demoClientApp/webpack.config.js +0 -39
  231. package/examples/single/bundle/.babelrc +0 -3
  232. package/examples/single/bundle/README.md +0 -11
  233. package/examples/single/bundle/client-app-profile.ttl +0 -10
  234. package/examples/single/bundle/package-lock.json +0 -11196
  235. package/examples/single/bundle/package.json +0 -31
  236. package/examples/single/bundle/src/App.js +0 -123
  237. package/examples/single/bundle/src/index.html +0 -10
  238. package/examples/single/bundle/src/index.js +0 -26
  239. package/examples/single/bundle/webpack.config.js +0 -33
  240. package/examples/single/script/README.md +0 -11
  241. package/examples/single/script/index.html +0 -36
  242. package/examples/single/script/package-lock.json +0 -1293
  243. package/examples/single/script/package.json +0 -20
  244. package/examples/single/script/server.ts +0 -18
  245. package/jest.config.js +0 -10
  246. package/licenses.csv +0 -147
  247. package/rollup.config.js +0 -54
  248. package/sampleFlows/SolidAuthClientArchitecture.png +0 -0
  249. package/sampleFlows/authorization-code-with-pkce.png +0 -0
  250. package/sampleFlows/authorization-code-with-pkce.seqdiag +0 -46
  251. package/sampleFlows/authorization-code.png +0 -0
  252. package/sampleFlows/authorization-code.seqdiag +0 -50
  253. package/sampleFlows/client-credentials.png +0 -0
  254. package/sampleFlows/client-credentials.seqdiag +0 -38
  255. package/sampleFlows/legacy-implicit-flow.png +0 -0
  256. package/sampleFlows/legacy-implicit-flow.seqdiag +0 -43
  257. package/sampleFlows/self-signed.png +0 -0
  258. package/sampleFlows/self-signed.seqdiag +0 -49
  259. package/sampleFlows/signatory-access-control.seqdiag +0 -36
  260. package/sampleFlows/signatory-access-control.svg +0 -1
  261. package/tsconfig.eslint.json +0 -6
  262. package/tsconfig.json +0 -17
package/docs/api/build/html/classes/Session.html DELETED
@@ -1,2428 +0,0 @@
1
-
2
- <!DOCTYPE html>
3
-
4
- <html>
5
- <head>
6
- <meta charset="utf-8" />
7
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
8
- <title>Class: Session &#8212; Inrupt solid-client-authn-browser API Documentation</title>
9
-
10
- <link href="../_static/css/theme.css" rel="stylesheet">
11
- <link href="../_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
12
-
13
-
14
- <link rel="stylesheet"
15
- href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
16
- <link rel="preload" as="font" type="font/woff2" crossorigin
17
- href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
18
- <link rel="preload" as="font" type="font/woff2" crossorigin
19
- href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
20
-
21
-
22
-
23
-
24
-
25
- <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
26
- <link rel="stylesheet" type="text/css" href="../_static/css/blank.css" />
27
- <link rel="stylesheet" href="../_static/css/inrupt.css" type="text/css" />
28
-
29
- <link rel="preload" as="script" href="../_static/js/index.be7d3bbb2ef33a8344ce.js">
30
-
31
- <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
32
- <script src="../_static/jquery.js"></script>
33
- <script src="../_static/underscore.js"></script>
34
- <script src="../_static/doctools.js"></script>
35
- <link rel="index" title="Index" href="../genindex.html" />
36
- <link rel="search" title="Search" href="../search.html" />
37
- <link rel="next" title="Functions" href="../functions.html" />
38
- <link rel="prev" title="Class: NotImplementedError" href="NotImplementedError.html" />
39
-
40
- <meta name="robots" content="index" />
41
-
42
-
43
-
44
- <meta name="viewport" content="width=device-width, initial-scale=1" />
45
- <meta name="docsearch:language" content="None">
46
-
47
-
48
- <link rel="icon" sizes="16x16" href="https://docs.inrupt.com/inrupt_stickers_v2-03.png">
49
-
50
-
51
-
52
- <!-- Google Analytics -->
53
-
54
-
55
- <script type="text/javascript"
56
- src="https://inrupt.atlassian.net/s/d41d8cd98f00b204e9800998ecf8427e-T/-egccmf/b/24/a44af77267a987a660377e5c46e0fb64/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?locale=en-US&collectorId=41592d74"></script>
57
- <script type="text/javascript">
58
- window.ATL_JQ_PAGE_PROPS = $.extend(window.ATL_JQ_PAGE_PROPS, {
59
- fieldValues: {
60
- description: 'On page: https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/classes/Session/ \n'
61
- }
62
- });
63
- </script>
64
-
65
- <!-- Matomo -->
66
- <script type="text/javascript">
67
- var _paq = window._paq = window._paq || [];
68
- /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
69
- _paq.push(['trackPageView']);
70
- _paq.push(['enableLinkTracking']);
71
- (function () {
72
- if (navigator.doNotTrack && navigator.doNotTrack === "1") {
73
- return;
74
- }
75
- var u = "https://inrupt.matomo.cloud/";
76
- _paq.push(['setTrackerUrl', u + 'matomo.php']);
77
- _paq.push(['setSiteId', '3']);
78
- var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
79
- g.type = 'text/javascript'; g.async = true; g.src = '//cdn.matomo.cloud/inrupt.matomo.cloud/matomo.js'; s.parentNode.insertBefore(g, s);
80
- })();
81
- </script>
82
- <!-- End Matomo Code -->
83
-
84
-
85
- </head>
86
- <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
87
-
88
- <div class="container-fluid" id="banner"></div>
89
-
90
-
91
- <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
92
-
93
- <div id="navbar-start">
94
-
95
- <!-- Override navbar-logo -->
96
-
97
- <a class="navbar-brand" href="https://inrupt.com/">
98
- <img src="https://docs.inrupt.com/inrupt-logo-small.svg" class="logo" alt="Inrupt logo">
99
- </a>
100
-
101
- </div>
102
-
103
- <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
104
- <span class="navbar-toggler-icon"></span>
105
- </button>
106
-
107
-
108
- <div id="navbar-collapsible" class=" collapse navbar-collapse">
109
- <div id="navbar-center" class="mr-auto">
110
-
111
- <div class="navbar-center-item">
112
- <!-- Override navbar-nav -->
113
-
114
- <ul id="navbar-main-elements" class="navbar-nav mr-auto">
115
- <li class="nav-item">
116
- <a class="nav-link" href="https://docs.inrupt.com/">Docs Home</a>
117
- </li>
118
- <li class="nav-item">
119
- <a class="nav-link" href="https://docs.inrupt.com/ess/latest/">Enterprise Solid Server</a>
120
- </li>
121
- <li class="nav-item"><a class="nav-link" href="#">Developer Tools</a>
122
- <ul class="nav-children">
123
- <li class="nav-item nav-childitem">
124
- <a href="https://docs.inrupt.com/developer-tools/javascript/client-libraries/">JavaScript Client Libraries</a>
125
- </li>
126
- <li class="nav-item nav-childitem">
127
- <a href="https://docs.inrupt.com/developer-tools/javascript/react-sdk/">Solid React SDK</a>
128
- </li>
129
- </ul>
130
- </li>
131
- <li class="nav-item">
132
- <a class="nav-link" href="https://docs.inrupt.com/user-interface/podbrowser/">PodBrowser</a>
133
- </li>
134
- <li class="nav-item">
135
- <a class="nav-link" href="https://docs.inrupt.com/pod-spaces/">Pod Spaces</a>
136
- </li>
137
- <li class="nav-item"><a class="nav-link" href="#">API</a>
138
- <ul class="nav-children">
139
- <li class="nav-item nav-childitem">
140
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client/" >solid-client (JS)</a>
141
- </li>
142
- <li class="nav-item nav-childitem">
143
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/" >solid-client-authn-browser (JS)</a>
144
- </li>
145
- <li class="nav-item nav-childitem">
146
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-node/">solid-client-authn-node (JS)</a>
147
- </li>
148
- <li class="nav-item nav-childitem">
149
- <a href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-notifications/">solid-client-notifications (JS)</a>
150
- </li>
151
- </ul>
152
- </li></ul>
153
- </div>
154
-
155
- </div>
156
-
157
- <div id="navbar-end">
158
-
159
- <div class="navbar-end-item">
160
- <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
161
- <li class="nav-item">
162
- <a class="nav-link" href="https://twitter.com/inrupt" rel="noopener" target="_blank" title="Inrupt on Twitter">
163
- <span><i class="fab fa-twitter-square"></i></span>
164
- <label class="sr-only">Inrupt on Twitter</label>
165
- </a>
166
- </li>
167
- <li class="nav-item">
168
- <a class="nav-link" href="https://www.linkedin.com/company/inrupt/" rel="noopener" target="_blank" title="Inrupt on LinkedIn">
169
- <span><i class="fab fa-linkedin"></i></span>
170
- <label class="sr-only">Inrupt on LinkedIn</label>
171
- </a>
172
- </li>
173
- <li class="nav-item">
174
- <a class="nav-link" href="https://forum.solidproject.org/" rel="noopener" target="_blank" title="Solid forum">
175
- <span><i class="fas fa-users"></i></span>
176
- <label class="sr-only">Solid forum</label>
177
- </a>
178
- </li>
179
- </ul>
180
- </div>
181
-
182
- </div>
183
- </div>
184
- </div>
185
- </nav>
186
-
187
-
188
- <div class="container-xl">
189
- <div class="row">
190
-
191
-
192
- <!-- Only show if we have sidebars configured, else just a small margin -->
193
- <div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../search.html" method="get">
194
- <i class="icon fas fa-search"></i>
195
- <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
196
- </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
197
- <div class="bd-toc-item active">
198
- <p class="caption">
199
- <a class="reference internal" href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser">Inrupt solid-client-authn-browser API</a>
200
- </p>
201
-
202
-
203
- <ul class="current nav bd-sidenav">
204
- <li class="toctree-l1">
205
- <a class="reference internal" href="ConfigurationError.html">
206
- Class: ConfigurationError
207
- </a>
208
- </li>
209
- <li class="toctree-l1">
210
- <a class="reference internal" href="InMemoryStorage.html">
211
- Class: InMemoryStorage
212
- </a>
213
- </li>
214
- <li class="toctree-l1">
215
- <a class="reference internal" href="NotImplementedError.html">
216
- Class: NotImplementedError
217
- </a>
218
- </li>
219
- <li class="toctree-l1 current active">
220
- <a class="current reference internal" href="#">
221
- Class: Session
222
- </a>
223
- </li>
224
- <li class="toctree-l1">
225
- <a class="reference internal" href="../functions.html">
226
- Functions
227
- </a>
228
- </li>
229
- <li class="toctree-l1">
230
- <a class="reference internal" href="../interfaces/ILoginInputOptions.html">
231
- Interface: ILoginInputOptions
232
- </a>
233
- </li>
234
- <li class="toctree-l1">
235
- <a class="reference internal" href="../interfaces/ISessionInfo.html">
236
- Interface: ISessionInfo
237
- </a>
238
- </li>
239
- <li class="toctree-l1">
240
- <a class="reference internal" href="../interfaces/ISessionOptions.html">
241
- Interface: ISessionOptions
242
- </a>
243
- </li>
244
- <li class="toctree-l1">
245
- <a class="reference internal" href="../interfaces/IStorage.html">
246
- Interface: IStorage
247
- </a>
248
- </li>
249
- </ul>
250
-
251
- </div>
252
- </nav>
253
- </div>
254
-
255
-
256
-
257
-
258
- <div class="d-none d-xl-block col-xl-2 bd-toc">
259
-
260
-
261
- <div class="toc-item">
262
-
263
- <div class="tocsection onthispage pt-5 pb-3">
264
- <i class="fas fa-list"></i> On this page
265
- </div>
266
-
267
- <nav id="bd-toc-nav">
268
- <ul class="visible nav section-nav flex-column">
269
- <li class="toc-h2 nav-item toc-entry">
270
- <a class="reference internal nav-link" href="#hierarchy">
271
- Hierarchy
272
- </a>
273
- </li>
274
- <li class="toc-h2 nav-item toc-entry">
275
- <a class="reference internal nav-link" href="#table-of-contents">
276
- Table of contents
277
- </a>
278
- <ul class="nav section-nav flex-column">
279
- <li class="toc-h3 nav-item toc-entry">
280
- <a class="reference internal nav-link" href="#constructors">
281
- Constructors
282
- </a>
283
- </li>
284
- <li class="toc-h3 nav-item toc-entry">
285
- <a class="reference internal nav-link" href="#properties">
286
- Properties
287
- </a>
288
- </li>
289
- <li class="toc-h3 nav-item toc-entry">
290
- <a class="reference internal nav-link" href="#methods">
291
- Methods
292
- </a>
293
- </li>
294
- </ul>
295
- </li>
296
- <li class="toc-h2 nav-item toc-entry">
297
- <a class="reference internal nav-link" href="#id1">
298
- Constructors
299
- </a>
300
- <ul class="nav section-nav flex-column">
301
- <li class="toc-h3 nav-item toc-entry">
302
- <a class="reference internal nav-link" href="#constructor">
303
- constructor
304
- </a>
305
- <ul class="nav section-nav flex-column">
306
- <li class="toc-h4 nav-item toc-entry">
307
- <a class="reference internal nav-link" href="#parameters">
308
- Parameters
309
- </a>
310
- </li>
311
- <li class="toc-h4 nav-item toc-entry">
312
- <a class="reference internal nav-link" href="#overrides">
313
- Overrides
314
- </a>
315
- </li>
316
- <li class="toc-h4 nav-item toc-entry">
317
- <a class="reference internal nav-link" href="#defined-in">
318
- Defined in
319
- </a>
320
- </li>
321
- </ul>
322
- </li>
323
- </ul>
324
- </li>
325
- <li class="toc-h2 nav-item toc-entry">
326
- <a class="reference internal nav-link" href="#id2">
327
- Properties
328
- </a>
329
- <ul class="nav section-nav flex-column">
330
- <li class="toc-h3 nav-item toc-entry">
331
- <a class="reference internal nav-link" href="#clientauthentication">
332
- clientAuthentication
333
- </a>
334
- <ul class="nav section-nav flex-column">
335
- <li class="toc-h4 nav-item toc-entry">
336
- <a class="reference internal nav-link" href="#id3">
337
- Defined in
338
- </a>
339
- </li>
340
- </ul>
341
- </li>
342
- <li class="toc-h3 nav-item toc-entry">
343
- <a class="reference internal nav-link" href="#info">
344
- info
345
- </a>
346
- <ul class="nav section-nav flex-column">
347
- <li class="toc-h4 nav-item toc-entry">
348
- <a class="reference internal nav-link" href="#id4">
349
- Defined in
350
- </a>
351
- </li>
352
- </ul>
353
- </li>
354
- <li class="toc-h3 nav-item toc-entry">
355
- <a class="reference internal nav-link" href="#tmpfetchwithcookies">
356
- tmpFetchWithCookies
357
- </a>
358
- <ul class="nav section-nav flex-column">
359
- <li class="toc-h4 nav-item toc-entry">
360
- <a class="reference internal nav-link" href="#id5">
361
- Defined in
362
- </a>
363
- </li>
364
- </ul>
365
- </li>
366
- <li class="toc-h3 nav-item toc-entry">
367
- <a class="reference internal nav-link" href="#tokenrequestinprogress">
368
- tokenRequestInProgress
369
- </a>
370
- <ul class="nav section-nav flex-column">
371
- <li class="toc-h4 nav-item toc-entry">
372
- <a class="reference internal nav-link" href="#id6">
373
- Defined in
374
- </a>
375
- </li>
376
- </ul>
377
- </li>
378
- <li class="toc-h3 nav-item toc-entry">
379
- <a class="reference internal nav-link" href="#capturerejectionsymbol">
380
- captureRejectionSymbol
381
- </a>
382
- <ul class="nav section-nav flex-column">
383
- <li class="toc-h4 nav-item toc-entry">
384
- <a class="reference internal nav-link" href="#inherited-from">
385
- Inherited from
386
- </a>
387
- </li>
388
- <li class="toc-h4 nav-item toc-entry">
389
- <a class="reference internal nav-link" href="#id7">
390
- Defined in
391
- </a>
392
- </li>
393
- </ul>
394
- </li>
395
- <li class="toc-h3 nav-item toc-entry">
396
- <a class="reference internal nav-link" href="#capturerejections">
397
- captureRejections
398
- </a>
399
- <ul class="nav section-nav flex-column">
400
- <li class="toc-h4 nav-item toc-entry">
401
- <a class="reference internal nav-link" href="#id8">
402
- Inherited from
403
- </a>
404
- </li>
405
- <li class="toc-h4 nav-item toc-entry">
406
- <a class="reference internal nav-link" href="#id9">
407
- Defined in
408
- </a>
409
- </li>
410
- </ul>
411
- </li>
412
- <li class="toc-h3 nav-item toc-entry">
413
- <a class="reference internal nav-link" href="#defaultmaxlisteners">
414
- defaultMaxListeners
415
- </a>
416
- <ul class="nav section-nav flex-column">
417
- <li class="toc-h4 nav-item toc-entry">
418
- <a class="reference internal nav-link" href="#id10">
419
- Inherited from
420
- </a>
421
- </li>
422
- <li class="toc-h4 nav-item toc-entry">
423
- <a class="reference internal nav-link" href="#id11">
424
- Defined in
425
- </a>
426
- </li>
427
- </ul>
428
- </li>
429
- <li class="toc-h3 nav-item toc-entry">
430
- <a class="reference internal nav-link" href="#errormonitor">
431
- errorMonitor
432
- </a>
433
- <ul class="nav section-nav flex-column">
434
- <li class="toc-h4 nav-item toc-entry">
435
- <a class="reference internal nav-link" href="#id12">
436
- Inherited from
437
- </a>
438
- </li>
439
- <li class="toc-h4 nav-item toc-entry">
440
- <a class="reference internal nav-link" href="#id13">
441
- Defined in
442
- </a>
443
- </li>
444
- </ul>
445
- </li>
446
- </ul>
447
- </li>
448
- <li class="toc-h2 nav-item toc-entry">
449
- <a class="reference internal nav-link" href="#id14">
450
- Methods
451
- </a>
452
- <ul class="nav section-nav flex-column">
453
- <li class="toc-h3 nav-item toc-entry">
454
- <a class="reference internal nav-link" href="#addlistener">
455
- addListener
456
- </a>
457
- <ul class="nav section-nav flex-column">
458
- <li class="toc-h4 nav-item toc-entry">
459
- <a class="reference internal nav-link" href="#id15">
460
- Parameters
461
- </a>
462
- </li>
463
- <li class="toc-h4 nav-item toc-entry">
464
- <a class="reference internal nav-link" href="#returns">
465
- Returns
466
- </a>
467
- </li>
468
- <li class="toc-h4 nav-item toc-entry">
469
- <a class="reference internal nav-link" href="#id16">
470
- Inherited from
471
- </a>
472
- </li>
473
- <li class="toc-h4 nav-item toc-entry">
474
- <a class="reference internal nav-link" href="#id17">
475
- Defined in
476
- </a>
477
- </li>
478
- </ul>
479
- </li>
480
- <li class="toc-h3 nav-item toc-entry">
481
- <a class="reference internal nav-link" href="#emit">
482
- emit
483
- </a>
484
- <ul class="nav section-nav flex-column">
485
- <li class="toc-h4 nav-item toc-entry">
486
- <a class="reference internal nav-link" href="#id18">
487
- Parameters
488
- </a>
489
- </li>
490
- <li class="toc-h4 nav-item toc-entry">
491
- <a class="reference internal nav-link" href="#id19">
492
- Returns
493
- </a>
494
- </li>
495
- <li class="toc-h4 nav-item toc-entry">
496
- <a class="reference internal nav-link" href="#id20">
497
- Inherited from
498
- </a>
499
- </li>
500
- <li class="toc-h4 nav-item toc-entry">
501
- <a class="reference internal nav-link" href="#id21">
502
- Defined in
503
- </a>
504
- </li>
505
- </ul>
506
- </li>
507
- <li class="toc-h3 nav-item toc-entry">
508
- <a class="reference internal nav-link" href="#eventnames">
509
- eventNames
510
- </a>
511
- <ul class="nav section-nav flex-column">
512
- <li class="toc-h4 nav-item toc-entry">
513
- <a class="reference internal nav-link" href="#id22">
514
- Returns
515
- </a>
516
- </li>
517
- <li class="toc-h4 nav-item toc-entry">
518
- <a class="reference internal nav-link" href="#id23">
519
- Inherited from
520
- </a>
521
- </li>
522
- <li class="toc-h4 nav-item toc-entry">
523
- <a class="reference internal nav-link" href="#id24">
524
- Defined in
525
- </a>
526
- </li>
527
- </ul>
528
- </li>
529
- <li class="toc-h3 nav-item toc-entry">
530
- <a class="reference internal nav-link" href="#fetch">
531
- fetch
532
- </a>
533
- <ul class="nav section-nav flex-column">
534
- <li class="toc-h4 nav-item toc-entry">
535
- <a class="reference internal nav-link" href="#id25">
536
- Parameters
537
- </a>
538
- </li>
539
- <li class="toc-h4 nav-item toc-entry">
540
- <a class="reference internal nav-link" href="#id26">
541
- Returns
542
- </a>
543
- </li>
544
- <li class="toc-h4 nav-item toc-entry">
545
- <a class="reference internal nav-link" href="#id27">
546
- Defined in
547
- </a>
548
- </li>
549
- </ul>
550
- </li>
551
- <li class="toc-h3 nav-item toc-entry">
552
- <a class="reference internal nav-link" href="#getmaxlisteners">
553
- getMaxListeners
554
- </a>
555
- <ul class="nav section-nav flex-column">
556
- <li class="toc-h4 nav-item toc-entry">
557
- <a class="reference internal nav-link" href="#id28">
558
- Returns
559
- </a>
560
- </li>
561
- <li class="toc-h4 nav-item toc-entry">
562
- <a class="reference internal nav-link" href="#id29">
563
- Inherited from
564
- </a>
565
- </li>
566
- <li class="toc-h4 nav-item toc-entry">
567
- <a class="reference internal nav-link" href="#id30">
568
- Defined in
569
- </a>
570
- </li>
571
- </ul>
572
- </li>
573
- <li class="toc-h3 nav-item toc-entry">
574
- <a class="reference internal nav-link" href="#handleincomingredirect">
575
- handleIncomingRedirect
576
- </a>
577
- <ul class="nav section-nav flex-column">
578
- <li class="toc-h4 nav-item toc-entry">
579
- <a class="reference internal nav-link" href="#id31">
580
- Parameters
581
- </a>
582
- </li>
583
- <li class="toc-h4 nav-item toc-entry">
584
- <a class="reference internal nav-link" href="#id32">
585
- Returns
586
- </a>
587
- </li>
588
- <li class="toc-h4 nav-item toc-entry">
589
- <a class="reference internal nav-link" href="#id33">
590
- Defined in
591
- </a>
592
- </li>
593
- </ul>
594
- </li>
595
- <li class="toc-h3 nav-item toc-entry">
596
- <a class="reference internal nav-link" href="#listenercount">
597
- listenerCount
598
- </a>
599
- <ul class="nav section-nav flex-column">
600
- <li class="toc-h4 nav-item toc-entry">
601
- <a class="reference internal nav-link" href="#id34">
602
- Parameters
603
- </a>
604
- </li>
605
- <li class="toc-h4 nav-item toc-entry">
606
- <a class="reference internal nav-link" href="#id35">
607
- Returns
608
- </a>
609
- </li>
610
- <li class="toc-h4 nav-item toc-entry">
611
- <a class="reference internal nav-link" href="#id36">
612
- Inherited from
613
- </a>
614
- </li>
615
- <li class="toc-h4 nav-item toc-entry">
616
- <a class="reference internal nav-link" href="#id37">
617
- Defined in
618
- </a>
619
- </li>
620
- </ul>
621
- </li>
622
- <li class="toc-h3 nav-item toc-entry">
623
- <a class="reference internal nav-link" href="#listeners">
624
- listeners
625
- </a>
626
- <ul class="nav section-nav flex-column">
627
- <li class="toc-h4 nav-item toc-entry">
628
- <a class="reference internal nav-link" href="#id38">
629
- Parameters
630
- </a>
631
- </li>
632
- <li class="toc-h4 nav-item toc-entry">
633
- <a class="reference internal nav-link" href="#id39">
634
- Returns
635
- </a>
636
- </li>
637
- <li class="toc-h4 nav-item toc-entry">
638
- <a class="reference internal nav-link" href="#id40">
639
- Inherited from
640
- </a>
641
- </li>
642
- <li class="toc-h4 nav-item toc-entry">
643
- <a class="reference internal nav-link" href="#id41">
644
- Defined in
645
- </a>
646
- </li>
647
- </ul>
648
- </li>
649
- <li class="toc-h3 nav-item toc-entry">
650
- <a class="reference internal nav-link" href="#login">
651
- login
652
- </a>
653
- <ul class="nav section-nav flex-column">
654
- <li class="toc-h4 nav-item toc-entry">
655
- <a class="reference internal nav-link" href="#id42">
656
- Parameters
657
- </a>
658
- </li>
659
- <li class="toc-h4 nav-item toc-entry">
660
- <a class="reference internal nav-link" href="#id43">
661
- Returns
662
- </a>
663
- </li>
664
- <li class="toc-h4 nav-item toc-entry">
665
- <a class="reference internal nav-link" href="#id44">
666
- Defined in
667
- </a>
668
- </li>
669
- </ul>
670
- </li>
671
- <li class="toc-h3 nav-item toc-entry">
672
- <a class="reference internal nav-link" href="#logout">
673
- logout
674
- </a>
675
- <ul class="nav section-nav flex-column">
676
- <li class="toc-h4 nav-item toc-entry">
677
- <a class="reference internal nav-link" href="#id45">
678
- Returns
679
- </a>
680
- </li>
681
- <li class="toc-h4 nav-item toc-entry">
682
- <a class="reference internal nav-link" href="#id46">
683
- Defined in
684
- </a>
685
- </li>
686
- </ul>
687
- </li>
688
- <li class="toc-h3 nav-item toc-entry">
689
- <a class="reference internal nav-link" href="#off">
690
- off
691
- </a>
692
- <ul class="nav section-nav flex-column">
693
- <li class="toc-h4 nav-item toc-entry">
694
- <a class="reference internal nav-link" href="#id47">
695
- Parameters
696
- </a>
697
- </li>
698
- <li class="toc-h4 nav-item toc-entry">
699
- <a class="reference internal nav-link" href="#id48">
700
- Returns
701
- </a>
702
- </li>
703
- <li class="toc-h4 nav-item toc-entry">
704
- <a class="reference internal nav-link" href="#id49">
705
- Inherited from
706
- </a>
707
- </li>
708
- <li class="toc-h4 nav-item toc-entry">
709
- <a class="reference internal nav-link" href="#id50">
710
- Defined in
711
- </a>
712
- </li>
713
- </ul>
714
- </li>
715
- <li class="toc-h3 nav-item toc-entry">
716
- <a class="reference internal nav-link" href="#on">
717
- on
718
- </a>
719
- <ul class="nav section-nav flex-column">
720
- <li class="toc-h4 nav-item toc-entry">
721
- <a class="reference internal nav-link" href="#id51">
722
- Parameters
723
- </a>
724
- </li>
725
- <li class="toc-h4 nav-item toc-entry">
726
- <a class="reference internal nav-link" href="#id52">
727
- Returns
728
- </a>
729
- </li>
730
- <li class="toc-h4 nav-item toc-entry">
731
- <a class="reference internal nav-link" href="#id53">
732
- Inherited from
733
- </a>
734
- </li>
735
- <li class="toc-h4 nav-item toc-entry">
736
- <a class="reference internal nav-link" href="#id54">
737
- Defined in
738
- </a>
739
- </li>
740
- </ul>
741
- </li>
742
- <li class="toc-h3 nav-item toc-entry">
743
- <a class="reference internal nav-link" href="#onerror">
744
- onError
745
- </a>
746
- <ul class="nav section-nav flex-column">
747
- <li class="toc-h4 nav-item toc-entry">
748
- <a class="reference internal nav-link" href="#id55">
749
- Parameters
750
- </a>
751
- </li>
752
- <li class="toc-h4 nav-item toc-entry">
753
- <a class="reference internal nav-link" href="#id56">
754
- Returns
755
- </a>
756
- </li>
757
- <li class="toc-h4 nav-item toc-entry">
758
- <a class="reference internal nav-link" href="#id57">
759
- Defined in
760
- </a>
761
- </li>
762
- </ul>
763
- </li>
764
- <li class="toc-h3 nav-item toc-entry">
765
- <a class="reference internal nav-link" href="#onlogin">
766
- onLogin
767
- </a>
768
- <ul class="nav section-nav flex-column">
769
- <li class="toc-h4 nav-item toc-entry">
770
- <a class="reference internal nav-link" href="#id58">
771
- Parameters
772
- </a>
773
- </li>
774
- <li class="toc-h4 nav-item toc-entry">
775
- <a class="reference internal nav-link" href="#id59">
776
- Returns
777
- </a>
778
- </li>
779
- <li class="toc-h4 nav-item toc-entry">
780
- <a class="reference internal nav-link" href="#id60">
781
- Defined in
782
- </a>
783
- </li>
784
- </ul>
785
- </li>
786
- <li class="toc-h3 nav-item toc-entry">
787
- <a class="reference internal nav-link" href="#onlogout">
788
- onLogout
789
- </a>
790
- <ul class="nav section-nav flex-column">
791
- <li class="toc-h4 nav-item toc-entry">
792
- <a class="reference internal nav-link" href="#id61">
793
- Parameters
794
- </a>
795
- </li>
796
- <li class="toc-h4 nav-item toc-entry">
797
- <a class="reference internal nav-link" href="#id62">
798
- Returns
799
- </a>
800
- </li>
801
- <li class="toc-h4 nav-item toc-entry">
802
- <a class="reference internal nav-link" href="#id63">
803
- Defined in
804
- </a>
805
- </li>
806
- </ul>
807
- </li>
808
- <li class="toc-h3 nav-item toc-entry">
809
- <a class="reference internal nav-link" href="#onsessionexpiration">
810
- onSessionExpiration
811
- </a>
812
- <ul class="nav section-nav flex-column">
813
- <li class="toc-h4 nav-item toc-entry">
814
- <a class="reference internal nav-link" href="#id64">
815
- Parameters
816
- </a>
817
- </li>
818
- <li class="toc-h4 nav-item toc-entry">
819
- <a class="reference internal nav-link" href="#id65">
820
- Returns
821
- </a>
822
- </li>
823
- <li class="toc-h4 nav-item toc-entry">
824
- <a class="reference internal nav-link" href="#id66">
825
- Defined in
826
- </a>
827
- </li>
828
- </ul>
829
- </li>
830
- <li class="toc-h3 nav-item toc-entry">
831
- <a class="reference internal nav-link" href="#onsessionrestore">
832
- onSessionRestore
833
- </a>
834
- <ul class="nav section-nav flex-column">
835
- <li class="toc-h4 nav-item toc-entry">
836
- <a class="reference internal nav-link" href="#id67">
837
- Parameters
838
- </a>
839
- </li>
840
- <li class="toc-h4 nav-item toc-entry">
841
- <a class="reference internal nav-link" href="#id68">
842
- Returns
843
- </a>
844
- </li>
845
- <li class="toc-h4 nav-item toc-entry">
846
- <a class="reference internal nav-link" href="#id69">
847
- Defined in
848
- </a>
849
- </li>
850
- </ul>
851
- </li>
852
- <li class="toc-h3 nav-item toc-entry">
853
- <a class="reference internal nav-link" href="#once">
854
- once
855
- </a>
856
- <ul class="nav section-nav flex-column">
857
- <li class="toc-h4 nav-item toc-entry">
858
- <a class="reference internal nav-link" href="#id70">
859
- Parameters
860
- </a>
861
- </li>
862
- <li class="toc-h4 nav-item toc-entry">
863
- <a class="reference internal nav-link" href="#id71">
864
- Returns
865
- </a>
866
- </li>
867
- <li class="toc-h4 nav-item toc-entry">
868
- <a class="reference internal nav-link" href="#id72">
869
- Inherited from
870
- </a>
871
- </li>
872
- <li class="toc-h4 nav-item toc-entry">
873
- <a class="reference internal nav-link" href="#id73">
874
- Defined in
875
- </a>
876
- </li>
877
- </ul>
878
- </li>
879
- <li class="toc-h3 nav-item toc-entry">
880
- <a class="reference internal nav-link" href="#prependlistener">
881
- prependListener
882
- </a>
883
- <ul class="nav section-nav flex-column">
884
- <li class="toc-h4 nav-item toc-entry">
885
- <a class="reference internal nav-link" href="#id74">
886
- Parameters
887
- </a>
888
- </li>
889
- <li class="toc-h4 nav-item toc-entry">
890
- <a class="reference internal nav-link" href="#id75">
891
- Returns
892
- </a>
893
- </li>
894
- <li class="toc-h4 nav-item toc-entry">
895
- <a class="reference internal nav-link" href="#id76">
896
- Inherited from
897
- </a>
898
- </li>
899
- <li class="toc-h4 nav-item toc-entry">
900
- <a class="reference internal nav-link" href="#id77">
901
- Defined in
902
- </a>
903
- </li>
904
- </ul>
905
- </li>
906
- <li class="toc-h3 nav-item toc-entry">
907
- <a class="reference internal nav-link" href="#prependoncelistener">
908
- prependOnceListener
909
- </a>
910
- <ul class="nav section-nav flex-column">
911
- <li class="toc-h4 nav-item toc-entry">
912
- <a class="reference internal nav-link" href="#id78">
913
- Parameters
914
- </a>
915
- </li>
916
- <li class="toc-h4 nav-item toc-entry">
917
- <a class="reference internal nav-link" href="#id79">
918
- Returns
919
- </a>
920
- </li>
921
- <li class="toc-h4 nav-item toc-entry">
922
- <a class="reference internal nav-link" href="#id80">
923
- Inherited from
924
- </a>
925
- </li>
926
- <li class="toc-h4 nav-item toc-entry">
927
- <a class="reference internal nav-link" href="#id81">
928
- Defined in
929
- </a>
930
- </li>
931
- </ul>
932
- </li>
933
- <li class="toc-h3 nav-item toc-entry">
934
- <a class="reference internal nav-link" href="#rawlisteners">
935
- rawListeners
936
- </a>
937
- <ul class="nav section-nav flex-column">
938
- <li class="toc-h4 nav-item toc-entry">
939
- <a class="reference internal nav-link" href="#id82">
940
- Parameters
941
- </a>
942
- </li>
943
- <li class="toc-h4 nav-item toc-entry">
944
- <a class="reference internal nav-link" href="#id83">
945
- Returns
946
- </a>
947
- </li>
948
- <li class="toc-h4 nav-item toc-entry">
949
- <a class="reference internal nav-link" href="#id84">
950
- Inherited from
951
- </a>
952
- </li>
953
- <li class="toc-h4 nav-item toc-entry">
954
- <a class="reference internal nav-link" href="#id85">
955
- Defined in
956
- </a>
957
- </li>
958
- </ul>
959
- </li>
960
- <li class="toc-h3 nav-item toc-entry">
961
- <a class="reference internal nav-link" href="#removealllisteners">
962
- removeAllListeners
963
- </a>
964
- <ul class="nav section-nav flex-column">
965
- <li class="toc-h4 nav-item toc-entry">
966
- <a class="reference internal nav-link" href="#id86">
967
- Parameters
968
- </a>
969
- </li>
970
- <li class="toc-h4 nav-item toc-entry">
971
- <a class="reference internal nav-link" href="#id87">
972
- Returns
973
- </a>
974
- </li>
975
- <li class="toc-h4 nav-item toc-entry">
976
- <a class="reference internal nav-link" href="#id88">
977
- Inherited from
978
- </a>
979
- </li>
980
- <li class="toc-h4 nav-item toc-entry">
981
- <a class="reference internal nav-link" href="#id89">
982
- Defined in
983
- </a>
984
- </li>
985
- </ul>
986
- </li>
987
- <li class="toc-h3 nav-item toc-entry">
988
- <a class="reference internal nav-link" href="#removelistener">
989
- removeListener
990
- </a>
991
- <ul class="nav section-nav flex-column">
992
- <li class="toc-h4 nav-item toc-entry">
993
- <a class="reference internal nav-link" href="#id90">
994
- Parameters
995
- </a>
996
- </li>
997
- <li class="toc-h4 nav-item toc-entry">
998
- <a class="reference internal nav-link" href="#id91">
999
- Returns
1000
- </a>
1001
- </li>
1002
- <li class="toc-h4 nav-item toc-entry">
1003
- <a class="reference internal nav-link" href="#id92">
1004
- Inherited from
1005
- </a>
1006
- </li>
1007
- <li class="toc-h4 nav-item toc-entry">
1008
- <a class="reference internal nav-link" href="#id93">
1009
- Defined in
1010
- </a>
1011
- </li>
1012
- </ul>
1013
- </li>
1014
- <li class="toc-h3 nav-item toc-entry">
1015
- <a class="reference internal nav-link" href="#setmaxlisteners">
1016
- setMaxListeners
1017
- </a>
1018
- <ul class="nav section-nav flex-column">
1019
- <li class="toc-h4 nav-item toc-entry">
1020
- <a class="reference internal nav-link" href="#id94">
1021
- Parameters
1022
- </a>
1023
- </li>
1024
- <li class="toc-h4 nav-item toc-entry">
1025
- <a class="reference internal nav-link" href="#id95">
1026
- Returns
1027
- </a>
1028
- </li>
1029
- <li class="toc-h4 nav-item toc-entry">
1030
- <a class="reference internal nav-link" href="#id96">
1031
- Inherited from
1032
- </a>
1033
- </li>
1034
- <li class="toc-h4 nav-item toc-entry">
1035
- <a class="reference internal nav-link" href="#id97">
1036
- Defined in
1037
- </a>
1038
- </li>
1039
- </ul>
1040
- </li>
1041
- <li class="toc-h3 nav-item toc-entry">
1042
- <a class="reference internal nav-link" href="#setsessioninfo">
1043
- setSessionInfo
1044
- </a>
1045
- <ul class="nav section-nav flex-column">
1046
- <li class="toc-h4 nav-item toc-entry">
1047
- <a class="reference internal nav-link" href="#id98">
1048
- Parameters
1049
- </a>
1050
- </li>
1051
- <li class="toc-h4 nav-item toc-entry">
1052
- <a class="reference internal nav-link" href="#id99">
1053
- Returns
1054
- </a>
1055
- </li>
1056
- <li class="toc-h4 nav-item toc-entry">
1057
- <a class="reference internal nav-link" href="#id100">
1058
- Defined in
1059
- </a>
1060
- </li>
1061
- </ul>
1062
- </li>
1063
- <li class="toc-h3 nav-item toc-entry">
1064
- <a class="reference internal nav-link" href="#geteventlistener">
1065
- getEventListener
1066
- </a>
1067
- <ul class="nav section-nav flex-column">
1068
- <li class="toc-h4 nav-item toc-entry">
1069
- <a class="reference internal nav-link" href="#id101">
1070
- Parameters
1071
- </a>
1072
- </li>
1073
- <li class="toc-h4 nav-item toc-entry">
1074
- <a class="reference internal nav-link" href="#id102">
1075
- Returns
1076
- </a>
1077
- </li>
1078
- <li class="toc-h4 nav-item toc-entry">
1079
- <a class="reference internal nav-link" href="#id103">
1080
- Inherited from
1081
- </a>
1082
- </li>
1083
- <li class="toc-h4 nav-item toc-entry">
1084
- <a class="reference internal nav-link" href="#id104">
1085
- Defined in
1086
- </a>
1087
- </li>
1088
- </ul>
1089
- </li>
1090
- <li class="toc-h3 nav-item toc-entry">
1091
- <a class="reference internal nav-link" href="#id105">
1092
- listenerCount
1093
- </a>
1094
- <ul class="nav section-nav flex-column">
1095
- <li class="toc-h4 nav-item toc-entry">
1096
- <a class="reference internal nav-link" href="#id106">
1097
- Parameters
1098
- </a>
1099
- </li>
1100
- <li class="toc-h4 nav-item toc-entry">
1101
- <a class="reference internal nav-link" href="#id107">
1102
- Returns
1103
- </a>
1104
- </li>
1105
- <li class="toc-h4 nav-item toc-entry">
1106
- <a class="reference internal nav-link" href="#id108">
1107
- Inherited from
1108
- </a>
1109
- </li>
1110
- <li class="toc-h4 nav-item toc-entry">
1111
- <a class="reference internal nav-link" href="#id109">
1112
- Defined in
1113
- </a>
1114
- </li>
1115
- </ul>
1116
- </li>
1117
- <li class="toc-h3 nav-item toc-entry">
1118
- <a class="reference internal nav-link" href="#id110">
1119
- on
1120
- </a>
1121
- <ul class="nav section-nav flex-column">
1122
- <li class="toc-h4 nav-item toc-entry">
1123
- <a class="reference internal nav-link" href="#id111">
1124
- Parameters
1125
- </a>
1126
- </li>
1127
- <li class="toc-h4 nav-item toc-entry">
1128
- <a class="reference internal nav-link" href="#id112">
1129
- Returns
1130
- </a>
1131
- </li>
1132
- <li class="toc-h4 nav-item toc-entry">
1133
- <a class="reference internal nav-link" href="#id113">
1134
- Inherited from
1135
- </a>
1136
- </li>
1137
- <li class="toc-h4 nav-item toc-entry">
1138
- <a class="reference internal nav-link" href="#id114">
1139
- Defined in
1140
- </a>
1141
- </li>
1142
- </ul>
1143
- </li>
1144
- <li class="toc-h3 nav-item toc-entry">
1145
- <a class="reference internal nav-link" href="#id115">
1146
- once
1147
- </a>
1148
- <ul class="nav section-nav flex-column">
1149
- <li class="toc-h4 nav-item toc-entry">
1150
- <a class="reference internal nav-link" href="#id116">
1151
- Parameters
1152
- </a>
1153
- </li>
1154
- <li class="toc-h4 nav-item toc-entry">
1155
- <a class="reference internal nav-link" href="#id117">
1156
- Returns
1157
- </a>
1158
- </li>
1159
- <li class="toc-h4 nav-item toc-entry">
1160
- <a class="reference internal nav-link" href="#id118">
1161
- Inherited from
1162
- </a>
1163
- </li>
1164
- <li class="toc-h4 nav-item toc-entry">
1165
- <a class="reference internal nav-link" href="#id119">
1166
- Defined in
1167
- </a>
1168
- </li>
1169
- <li class="toc-h4 nav-item toc-entry">
1170
- <a class="reference internal nav-link" href="#id120">
1171
- Parameters
1172
- </a>
1173
- </li>
1174
- <li class="toc-h4 nav-item toc-entry">
1175
- <a class="reference internal nav-link" href="#id121">
1176
- Returns
1177
- </a>
1178
- </li>
1179
- <li class="toc-h4 nav-item toc-entry">
1180
- <a class="reference internal nav-link" href="#id122">
1181
- Inherited from
1182
- </a>
1183
- </li>
1184
- <li class="toc-h4 nav-item toc-entry">
1185
- <a class="reference internal nav-link" href="#id123">
1186
- Defined in
1187
- </a>
1188
- </li>
1189
- </ul>
1190
- </li>
1191
- </ul>
1192
- </li>
1193
- </ul>
1194
-
1195
- </nav>
1196
- </div>
1197
-
1198
- <div class="toc-item">
1199
-
1200
- </div>
1201
-
1202
-
1203
- </div>
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
- <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
1211
-
1212
-
1213
- <div class="related">
1214
-
1215
- </div>
1216
-
1217
-
1218
- <div>
1219
-
1220
- <p><a class="reference internal" href="../index.html"><span class="doc std std-doc">&#64;inrupt/solid-client-authn-browser</span></a> / Session</p>
1221
- <div class="tex2jax_ignore mathjax_ignore section" id="class-session">
1222
- <h1>Class: Session<a class="headerlink" href="#class-session" title="Permalink to this headline">¶</a></h1>
1223
- <p>A <a class="reference internal" href="#"><span class="doc std std-doc">Session</span></a> object represents a user’s session on an application. The session holds state, as it stores information enabling acces to private resources after login for instance.</p>
1224
- <div class="section" id="hierarchy">
1225
- <h2>Hierarchy<a class="headerlink" href="#hierarchy" title="Permalink to this headline">¶</a></h2>
1226
- <ul>
1227
- <li><p><code class="docutils literal notranslate"><span class="pre">EventEmitter</span></code></p>
1228
- <p>↳ <strong><code class="docutils literal notranslate"><span class="pre">Session</span></code></strong></p>
1229
- </li>
1230
- </ul>
1231
- </div>
1232
- <div class="section" id="table-of-contents">
1233
- <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
1234
- <div class="section" id="constructors">
1235
- <h3>Constructors<a class="headerlink" href="#constructors" title="Permalink to this headline">¶</a></h3>
1236
- <ul class="simple">
1237
- <li><p><a class="reference external" href="Session.html#constructor">constructor</a></p></li>
1238
- </ul>
1239
- </div>
1240
- <div class="section" id="properties">
1241
- <h3>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h3>
1242
- <ul class="simple">
1243
- <li><p><a class="reference external" href="Session.html#clientauthentication">clientAuthentication</a></p></li>
1244
- <li><p><a class="reference external" href="Session.html#info">info</a></p></li>
1245
- <li><p><a class="reference external" href="Session.html#tmpfetchwithcookies">tmpFetchWithCookies</a></p></li>
1246
- <li><p><a class="reference external" href="Session.html#tokenrequestinprogress">tokenRequestInProgress</a></p></li>
1247
- <li><p><a class="reference external" href="Session.html#capturerejectionsymbol">captureRejectionSymbol</a></p></li>
1248
- <li><p><a class="reference external" href="Session.html#capturerejections">captureRejections</a></p></li>
1249
- <li><p><a class="reference external" href="Session.html#defaultmaxlisteners">defaultMaxListeners</a></p></li>
1250
- <li><p><a class="reference external" href="Session.html#errormonitor">errorMonitor</a></p></li>
1251
- </ul>
1252
- </div>
1253
- <div class="section" id="methods">
1254
- <h3>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h3>
1255
- <ul class="simple">
1256
- <li><p><a class="reference external" href="Session.html#addlistener">addListener</a></p></li>
1257
- <li><p><a class="reference external" href="Session.html#emit">emit</a></p></li>
1258
- <li><p><a class="reference external" href="Session.html#eventnames">eventNames</a></p></li>
1259
- <li><p><a class="reference external" href="Session.html#fetch">fetch</a></p></li>
1260
- <li><p><a class="reference external" href="Session.html#getmaxlisteners">getMaxListeners</a></p></li>
1261
- <li><p><a class="reference external" href="Session.html#handleincomingredirect">handleIncomingRedirect</a></p></li>
1262
- <li><p><a class="reference external" href="Session.html#listenercount">listenerCount</a></p></li>
1263
- <li><p><a class="reference external" href="Session.html#listeners">listeners</a></p></li>
1264
- <li><p><a class="reference external" href="Session.html#login">login</a></p></li>
1265
- <li><p><a class="reference external" href="Session.html#logout">logout</a></p></li>
1266
- <li><p><a class="reference external" href="Session.html#off">off</a></p></li>
1267
- <li><p><a class="reference external" href="Session.html#on">on</a></p></li>
1268
- <li><p><a class="reference external" href="Session.html#onerror">onError</a></p></li>
1269
- <li><p><a class="reference external" href="Session.html#onlogin">onLogin</a></p></li>
1270
- <li><p><a class="reference external" href="Session.html#onlogout">onLogout</a></p></li>
1271
- <li><p><a class="reference external" href="Session.html#onsessionexpiration">onSessionExpiration</a></p></li>
1272
- <li><p><a class="reference external" href="Session.html#onsessionrestore">onSessionRestore</a></p></li>
1273
- <li><p><a class="reference external" href="Session.html#once">once</a></p></li>
1274
- <li><p><a class="reference external" href="Session.html#prependlistener">prependListener</a></p></li>
1275
- <li><p><a class="reference external" href="Session.html#prependoncelistener">prependOnceListener</a></p></li>
1276
- <li><p><a class="reference external" href="Session.html#rawlisteners">rawListeners</a></p></li>
1277
- <li><p><a class="reference external" href="Session.html#removealllisteners">removeAllListeners</a></p></li>
1278
- <li><p><a class="reference external" href="Session.html#removelistener">removeListener</a></p></li>
1279
- <li><p><a class="reference external" href="Session.html#setmaxlisteners">setMaxListeners</a></p></li>
1280
- <li><p><a class="reference external" href="Session.html#setsessioninfo">setSessionInfo</a></p></li>
1281
- <li><p><a class="reference external" href="Session.html#geteventlistener">getEventListener</a></p></li>
1282
- <li><p><a class="reference external" href="Session.html#listenercount">listenerCount</a></p></li>
1283
- <li><p><a class="reference external" href="Session.html#on">on</a></p></li>
1284
- <li><p><a class="reference external" href="Session.html#once">once</a></p></li>
1285
- </ul>
1286
- </div>
1287
- </div>
1288
- <div class="section" id="id1">
1289
- <h2>Constructors<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
1290
- <div class="section" id="constructor">
1291
- <h3>constructor<a class="headerlink" href="#constructor" title="Permalink to this headline">¶</a></h3>
1292
- <p>• <strong>new Session</strong>(<code class="docutils literal notranslate"><span class="pre">sessionOptions?</span></code>, <code class="docutils literal notranslate"><span class="pre">sessionId?</span></code>)</p>
1293
- <p>Session object constructor. Typically called as follows:</p>
1294
- <div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span> <span class="nx">session</span> <span class="o">=</span> <span class="ow">new</span> <span class="nx">Session</span><span class="p">();</span>
1295
- </pre></div>
1296
- </div>
1297
- <p>See also <a class="reference external" href="https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/functions.html#getdefaultsession">getDefaultSession</a>.</p>
1298
- <div class="section" id="parameters">
1299
- <h4>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h4>
1300
- <table class="colwidths-auto table">
1301
- <thead>
1302
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1303
- <th class="text-align:left head"><p>Type</p></th>
1304
- <th class="text-align:left head"><p>Description</p></th>
1305
- </tr>
1306
- </thead>
1307
- <tbody>
1308
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">sessionOptions</span></code></p></td>
1309
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">Partial</span></code>&lt;<a class="reference internal" href="../interfaces/ISessionOptions.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionOptions</span></code></span></a>&gt;</p></td>
1310
- <td class="text-align:left"><p>The options enabling the correct instantiation of the session. Either both storages or clientAuthentication are required. For more information, see <a class="reference internal" href="../interfaces/ISessionOptions.html"><span class="doc std std-doc">ISessionOptions</span></a>.</p></td>
1311
- </tr>
1312
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">sessionId?</span></code></p></td>
1313
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
1314
- <td class="text-align:left"><p>A string uniquely identifying the session.</p></td>
1315
- </tr>
1316
- </tbody>
1317
- </table>
1318
- </div>
1319
- <div class="section" id="overrides">
1320
- <h4>Overrides<a class="headerlink" href="#overrides" title="Permalink to this headline">¶</a></h4>
1321
- <p>EventEmitter.constructor</p>
1322
- </div>
1323
- <div class="section" id="defined-in">
1324
- <h4>Defined in<a class="headerlink" href="#defined-in" title="Permalink to this headline">¶</a></h4>
1325
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L173">browser/src/Session.ts:173</a></p>
1326
- </div>
1327
- </div>
1328
- </div>
1329
- <div class="section" id="id2">
1330
- <h2>Properties<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
1331
- <div class="section" id="clientauthentication">
1332
- <h3>clientAuthentication<a class="headerlink" href="#clientauthentication" title="Permalink to this headline">¶</a></h3>
1333
- <p>• <code class="docutils literal notranslate"><span class="pre">Private</span></code> <strong>clientAuthentication</strong>: <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
1334
- <div class="section" id="id3">
1335
- <h4>Defined in<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
1336
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L151">browser/src/Session.ts:151</a></p>
1337
- </div>
1338
- </div>
1339
- <hr class="docutils" />
1340
- <div class="section" id="info">
1341
- <h3>info<a class="headerlink" href="#info" title="Permalink to this headline">¶</a></h3>
1342
- <p>• <code class="docutils literal notranslate"><span class="pre">Readonly</span></code> <strong>info</strong>: <a class="reference internal" href="../interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a></p>
1343
- <p>Information regarding the current session.</p>
1344
- <div class="section" id="id4">
1345
- <h4>Defined in<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
1346
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L149">browser/src/Session.ts:149</a></p>
1347
- </div>
1348
- </div>
1349
- <hr class="docutils" />
1350
- <div class="section" id="tmpfetchwithcookies">
1351
- <h3>tmpFetchWithCookies<a class="headerlink" href="#tmpfetchwithcookies" title="Permalink to this headline">¶</a></h3>
1352
- <p>• <code class="docutils literal notranslate"><span class="pre">Private</span></code> <strong>tmpFetchWithCookies</strong>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> = <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
1353
- <div class="section" id="id5">
1354
- <h4>Defined in<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
1355
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L156">browser/src/Session.ts:156</a></p>
1356
- </div>
1357
- </div>
1358
- <hr class="docutils" />
1359
- <div class="section" id="tokenrequestinprogress">
1360
- <h3>tokenRequestInProgress<a class="headerlink" href="#tokenrequestinprogress" title="Permalink to this headline">¶</a></h3>
1361
- <p>• <code class="docutils literal notranslate"><span class="pre">Private</span></code> <strong>tokenRequestInProgress</strong>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> = <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
1362
- <div class="section" id="id6">
1363
- <h4>Defined in<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
1364
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L153">browser/src/Session.ts:153</a></p>
1365
- </div>
1366
- </div>
1367
- <hr class="docutils" />
1368
- <div class="section" id="capturerejectionsymbol">
1369
- <h3>captureRejectionSymbol<a class="headerlink" href="#capturerejectionsymbol" title="Permalink to this headline">¶</a></h3>
1370
- <p>▪ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <code class="docutils literal notranslate"><span class="pre">Readonly</span></code> <strong>captureRejectionSymbol</strong>: typeof <a class="reference external" href="Session.html#capturerejectionsymbol"><code class="docutils literal notranslate"><span class="pre">captureRejectionSymbol</span></code></a></p>
1371
- <div class="section" id="inherited-from">
1372
- <h4>Inherited from<a class="headerlink" href="#inherited-from" title="Permalink to this headline">¶</a></h4>
1373
- <p>EventEmitter.captureRejectionSymbol</p>
1374
- </div>
1375
- <div class="section" id="id7">
1376
- <h4>Defined in<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
1377
- <p>browser/node_modules/&#64;types/node/events.d.ts:46</p>
1378
- </div>
1379
- </div>
1380
- <hr class="docutils" />
1381
- <div class="section" id="capturerejections">
1382
- <h3>captureRejections<a class="headerlink" href="#capturerejections" title="Permalink to this headline">¶</a></h3>
1383
- <p>▪ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>captureRejections</strong>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></p>
1384
- <p>Sets or gets the default captureRejection value for all emitters.</p>
1385
- <div class="section" id="id8">
1386
- <h4>Inherited from<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
1387
- <p>EventEmitter.captureRejections</p>
1388
- </div>
1389
- <div class="section" id="id9">
1390
- <h4>Defined in<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h4>
1391
- <p>browser/node_modules/&#64;types/node/events.d.ts:52</p>
1392
- </div>
1393
- </div>
1394
- <hr class="docutils" />
1395
- <div class="section" id="defaultmaxlisteners">
1396
- <h3>defaultMaxListeners<a class="headerlink" href="#defaultmaxlisteners" title="Permalink to this headline">¶</a></h3>
1397
- <p>▪ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>defaultMaxListeners</strong>: <code class="docutils literal notranslate"><span class="pre">number</span></code></p>
1398
- <div class="section" id="id10">
1399
- <h4>Inherited from<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h4>
1400
- <p>EventEmitter.defaultMaxListeners</p>
1401
- </div>
1402
- <div class="section" id="id11">
1403
- <h4>Defined in<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h4>
1404
- <p>browser/node_modules/&#64;types/node/events.d.ts:53</p>
1405
- </div>
1406
- </div>
1407
- <hr class="docutils" />
1408
- <div class="section" id="errormonitor">
1409
- <h3>errorMonitor<a class="headerlink" href="#errormonitor" title="Permalink to this headline">¶</a></h3>
1410
- <p>▪ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <code class="docutils literal notranslate"><span class="pre">Readonly</span></code> <strong>errorMonitor</strong>: typeof <a class="reference external" href="Session.html#errormonitor"><code class="docutils literal notranslate"><span class="pre">errorMonitor</span></code></a></p>
1411
- <p>This symbol shall be used to install a listener for only monitoring <code class="docutils literal notranslate"><span class="pre">'error'</span></code>
1412
- events. Listeners installed using this symbol are called before the regular
1413
- <code class="docutils literal notranslate"><span class="pre">'error'</span></code> listeners are called.</p>
1414
- <p>Installing a listener using this symbol does not change the behavior once an
1415
- <code class="docutils literal notranslate"><span class="pre">'error'</span></code> event is emitted, therefore the process will still crash if no
1416
- regular <code class="docutils literal notranslate"><span class="pre">'error'</span></code> listener is installed.</p>
1417
- <div class="section" id="id12">
1418
- <h4>Inherited from<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h4>
1419
- <p>EventEmitter.errorMonitor</p>
1420
- </div>
1421
- <div class="section" id="id13">
1422
- <h4>Defined in<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h4>
1423
- <p>browser/node_modules/&#64;types/node/events.d.ts:45</p>
1424
- </div>
1425
- </div>
1426
- </div>
1427
- <div class="section" id="id14">
1428
- <h2>Methods<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h2>
1429
- <div class="section" id="addlistener">
1430
- <h3>addListener<a class="headerlink" href="#addlistener" title="Permalink to this headline">¶</a></h3>
1431
- <p>▸ <strong>addListener</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1432
- <div class="section" id="id15">
1433
- <h4>Parameters<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h4>
1434
- <table class="colwidths-auto table">
1435
- <thead>
1436
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1437
- <th class="text-align:left head"><p>Type</p></th>
1438
- </tr>
1439
- </thead>
1440
- <tbody>
1441
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1442
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1443
- </tr>
1444
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
1445
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
1446
- </tr>
1447
- </tbody>
1448
- </table>
1449
- </div>
1450
- <div class="section" id="returns">
1451
- <h4>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h4>
1452
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1453
- </div>
1454
- <div class="section" id="id16">
1455
- <h4>Inherited from<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h4>
1456
- <p>EventEmitter.addListener</p>
1457
- </div>
1458
- <div class="section" id="id17">
1459
- <h4>Defined in<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h4>
1460
- <p>browser/node_modules/&#64;types/node/events.d.ts:72</p>
1461
- </div>
1462
- </div>
1463
- <hr class="docutils" />
1464
- <div class="section" id="emit">
1465
- <h3>emit<a class="headerlink" href="#emit" title="Permalink to this headline">¶</a></h3>
1466
- <p>▸ <strong>emit</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, …<code class="docutils literal notranslate"><span class="pre">args</span></code>): <code class="docutils literal notranslate"><span class="pre">boolean</span></code></p>
1467
- <div class="section" id="id18">
1468
- <h4>Parameters<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h4>
1469
- <table class="colwidths-auto table">
1470
- <thead>
1471
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1472
- <th class="text-align:left head"><p>Type</p></th>
1473
- </tr>
1474
- </thead>
1475
- <tbody>
1476
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1477
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1478
- </tr>
1479
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">...args</span></code></p></td>
1480
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">any</span></code>[]</p></td>
1481
- </tr>
1482
- </tbody>
1483
- </table>
1484
- </div>
1485
- <div class="section" id="id19">
1486
- <h4>Returns<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h4>
1487
- <p><code class="docutils literal notranslate"><span class="pre">boolean</span></code></p>
1488
- </div>
1489
- <div class="section" id="id20">
1490
- <h4>Inherited from<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h4>
1491
- <p>EventEmitter.emit</p>
1492
- </div>
1493
- <div class="section" id="id21">
1494
- <h4>Defined in<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h4>
1495
- <p>browser/node_modules/&#64;types/node/events.d.ts:82</p>
1496
- </div>
1497
- </div>
1498
- <hr class="docutils" />
1499
- <div class="section" id="eventnames">
1500
- <h3>eventNames<a class="headerlink" href="#eventnames" title="Permalink to this headline">¶</a></h3>
1501
- <p>▸ <strong>eventNames</strong>(): (<code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code>)[]</p>
1502
- <div class="section" id="id22">
1503
- <h4>Returns<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h4>
1504
- <p>(<code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code>)[]</p>
1505
- </div>
1506
- <div class="section" id="id23">
1507
- <h4>Inherited from<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h4>
1508
- <p>EventEmitter.eventNames</p>
1509
- </div>
1510
- <div class="section" id="id24">
1511
- <h4>Defined in<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h4>
1512
- <p>browser/node_modules/&#64;types/node/events.d.ts:87</p>
1513
- </div>
1514
- </div>
1515
- <hr class="docutils" />
1516
- <div class="section" id="fetch">
1517
- <h3>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h3>
1518
- <p>▸ <strong>fetch</strong>(<code class="docutils literal notranslate"><span class="pre">url</span></code>, <code class="docutils literal notranslate"><span class="pre">init?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">Response</span></code>&gt;</p>
1519
- <p>Fetches data using available login information. If the user is not logged in, this will behave as a regular <code class="docutils literal notranslate"><span class="pre">fetch</span></code>. The signature of this method is identical to the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">canonical <code class="docutils literal notranslate"><span class="pre">fetch</span></code></a>.</p>
1520
- <div class="section" id="id25">
1521
- <h4>Parameters<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h4>
1522
- <table class="colwidths-auto table">
1523
- <thead>
1524
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1525
- <th class="text-align:left head"><p>Type</p></th>
1526
- <th class="text-align:left head"><p>Description</p></th>
1527
- </tr>
1528
- </thead>
1529
- <tbody>
1530
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">url</span></code></p></td>
1531
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">RequestInfo</span></code></p></td>
1532
- <td class="text-align:left"><p>The URL from which data should be fetched.</p></td>
1533
- </tr>
1534
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">init?</span></code></p></td>
1535
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">RequestInit</span></code></p></td>
1536
- <td class="text-align:left"><p>Optional parameters customizing the request, by specifying an HTTP method, headers, a body, etc. Follows the <a class="reference external" href="https://fetch.spec.whatwg.org/">WHATWG Fetch Standard</a>.</p></td>
1537
- </tr>
1538
- </tbody>
1539
- </table>
1540
- </div>
1541
- <div class="section" id="id26">
1542
- <h4>Returns<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h4>
1543
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">Response</span></code>&gt;</p>
1544
- </div>
1545
- <div class="section" id="id27">
1546
- <h4>Defined in<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h4>
1547
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L265">browser/src/Session.ts:265</a></p>
1548
- </div>
1549
- </div>
1550
- <hr class="docutils" />
1551
- <div class="section" id="getmaxlisteners">
1552
- <h3>getMaxListeners<a class="headerlink" href="#getmaxlisteners" title="Permalink to this headline">¶</a></h3>
1553
- <p>▸ <strong>getMaxListeners</strong>(): <code class="docutils literal notranslate"><span class="pre">number</span></code></p>
1554
- <div class="section" id="id28">
1555
- <h4>Returns<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h4>
1556
- <p><code class="docutils literal notranslate"><span class="pre">number</span></code></p>
1557
- </div>
1558
- <div class="section" id="id29">
1559
- <h4>Inherited from<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h4>
1560
- <p>EventEmitter.getMaxListeners</p>
1561
- </div>
1562
- <div class="section" id="id30">
1563
- <h4>Defined in<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h4>
1564
- <p>browser/node_modules/&#64;types/node/events.d.ts:79</p>
1565
- </div>
1566
- </div>
1567
- <hr class="docutils" />
1568
- <div class="section" id="handleincomingredirect">
1569
- <h3>handleIncomingRedirect<a class="headerlink" href="#handleincomingredirect" title="Permalink to this headline">¶</a></h3>
1570
- <p>▸ <strong>handleIncomingRedirect</strong>(<code class="docutils literal notranslate"><span class="pre">inputOptions?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">undefined</span></code> | <a class="reference internal" href="../interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a>&gt;</p>
1571
- <p>Completes the login process by processing the information provided by the
1572
- Solid identity provider through redirect.</p>
1573
- <div class="section" id="id31">
1574
- <h4>Parameters<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h4>
1575
- <table class="colwidths-auto table">
1576
- <thead>
1577
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1578
- <th class="text-align:left head"><p>Type</p></th>
1579
- </tr>
1580
- </thead>
1581
- <tbody>
1582
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">inputOptions</span></code></p></td>
1583
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">IHandleIncomingRedirectOptions</span></code></p></td>
1584
- </tr>
1585
- </tbody>
1586
- </table>
1587
- </div>
1588
- <div class="section" id="id32">
1589
- <h4>Returns<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h4>
1590
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">undefined</span></code> | <a class="reference internal" href="../interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a>&gt;</p>
1591
- </div>
1592
- <div class="section" id="id33">
1593
- <h4>Defined in<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h4>
1594
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L292">browser/src/Session.ts:292</a></p>
1595
- </div>
1596
- </div>
1597
- <hr class="docutils" />
1598
- <div class="section" id="listenercount">
1599
- <h3>listenerCount<a class="headerlink" href="#listenercount" title="Permalink to this headline">¶</a></h3>
1600
- <p>▸ <strong>listenerCount</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>): <code class="docutils literal notranslate"><span class="pre">number</span></code></p>
1601
- <div class="section" id="id34">
1602
- <h4>Parameters<a class="headerlink" href="#id34" title="Permalink to this headline">¶</a></h4>
1603
- <table class="colwidths-auto table">
1604
- <thead>
1605
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1606
- <th class="text-align:left head"><p>Type</p></th>
1607
- </tr>
1608
- </thead>
1609
- <tbody>
1610
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1611
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1612
- </tr>
1613
- </tbody>
1614
- </table>
1615
- </div>
1616
- <div class="section" id="id35">
1617
- <h4>Returns<a class="headerlink" href="#id35" title="Permalink to this headline">¶</a></h4>
1618
- <p><code class="docutils literal notranslate"><span class="pre">number</span></code></p>
1619
- </div>
1620
- <div class="section" id="id36">
1621
- <h4>Inherited from<a class="headerlink" href="#id36" title="Permalink to this headline">¶</a></h4>
1622
- <p>EventEmitter.listenerCount</p>
1623
- </div>
1624
- <div class="section" id="id37">
1625
- <h4>Defined in<a class="headerlink" href="#id37" title="Permalink to this headline">¶</a></h4>
1626
- <p>browser/node_modules/&#64;types/node/events.d.ts:83</p>
1627
- </div>
1628
- </div>
1629
- <hr class="docutils" />
1630
- <div class="section" id="listeners">
1631
- <h3>listeners<a class="headerlink" href="#listeners" title="Permalink to this headline">¶</a></h3>
1632
- <p>▸ <strong>listeners</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>): <code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
1633
- <div class="section" id="id38">
1634
- <h4>Parameters<a class="headerlink" href="#id38" title="Permalink to this headline">¶</a></h4>
1635
- <table class="colwidths-auto table">
1636
- <thead>
1637
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1638
- <th class="text-align:left head"><p>Type</p></th>
1639
- </tr>
1640
- </thead>
1641
- <tbody>
1642
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1643
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1644
- </tr>
1645
- </tbody>
1646
- </table>
1647
- </div>
1648
- <div class="section" id="id39">
1649
- <h4>Returns<a class="headerlink" href="#id39" title="Permalink to this headline">¶</a></h4>
1650
- <p><code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
1651
- </div>
1652
- <div class="section" id="id40">
1653
- <h4>Inherited from<a class="headerlink" href="#id40" title="Permalink to this headline">¶</a></h4>
1654
- <p>EventEmitter.listeners</p>
1655
- </div>
1656
- <div class="section" id="id41">
1657
- <h4>Defined in<a class="headerlink" href="#id41" title="Permalink to this headline">¶</a></h4>
1658
- <p>browser/node_modules/&#64;types/node/events.d.ts:80</p>
1659
- </div>
1660
- </div>
1661
- <hr class="docutils" />
1662
- <div class="section" id="login">
1663
- <h3>login<a class="headerlink" href="#login" title="Permalink to this headline">¶</a></h3>
1664
- <p>▸ <strong>login</strong>(<code class="docutils literal notranslate"><span class="pre">options</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
1665
- <p>Triggers the login process. Note that this method will redirect the user away from your app.</p>
1666
- <div class="section" id="id42">
1667
- <h4>Parameters<a class="headerlink" href="#id42" title="Permalink to this headline">¶</a></h4>
1668
- <table class="colwidths-auto table">
1669
- <thead>
1670
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1671
- <th class="text-align:left head"><p>Type</p></th>
1672
- <th class="text-align:left head"><p>Description</p></th>
1673
- </tr>
1674
- </thead>
1675
- <tbody>
1676
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">options</span></code></p></td>
1677
- <td class="text-align:left"><p><a class="reference internal" href="../interfaces/ILoginInputOptions.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ILoginInputOptions</span></code></span></a></p></td>
1678
- <td class="text-align:left"><p>Parameter to customize the login behaviour. In particular, two options are mandatory: <code class="docutils literal notranslate"><span class="pre">options.oidcIssuer</span></code>, the user’s identity provider, and <code class="docutils literal notranslate"><span class="pre">options.redirectUrl</span></code>, the URL to which the user will be redirected after logging in their identity provider.</p></td>
1679
- </tr>
1680
- </tbody>
1681
- </table>
1682
- </div>
1683
- <div class="section" id="id43">
1684
- <h4>Returns<a class="headerlink" href="#id43" title="Permalink to this headline">¶</a></h4>
1685
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
1686
- <p>This method should redirect the user away from the app: it does not return anything. The login process is completed by <a class="reference external" href="Session.html#handleincomingredirect"><code class="docutils literal notranslate"><span class="pre">handleIncomingRedirect</span></code></a>.</p>
1687
- </div>
1688
- <div class="section" id="id44">
1689
- <h4>Defined in<a class="headerlink" href="#id44" title="Permalink to this headline">¶</a></h4>
1690
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L242">browser/src/Session.ts:242</a></p>
1691
- </div>
1692
- </div>
1693
- <hr class="docutils" />
1694
- <div class="section" id="logout">
1695
- <h3>logout<a class="headerlink" href="#logout" title="Permalink to this headline">¶</a></h3>
1696
- <p>▸ <strong>logout</strong>(): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
1697
- <p>Logs the user out of the application. This does not log the user out of their Solid identity provider, and should not redirect the user away.</p>
1698
- <div class="section" id="id45">
1699
- <h4>Returns<a class="headerlink" href="#id45" title="Permalink to this headline">¶</a></h4>
1700
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">void</span></code>&gt;</p>
1701
- </div>
1702
- <div class="section" id="id46">
1703
- <h4>Defined in<a class="headerlink" href="#id46" title="Permalink to this headline">¶</a></h4>
1704
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L279">browser/src/Session.ts:279</a></p>
1705
- </div>
1706
- </div>
1707
- <hr class="docutils" />
1708
- <div class="section" id="off">
1709
- <h3>off<a class="headerlink" href="#off" title="Permalink to this headline">¶</a></h3>
1710
- <p>▸ <strong>off</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1711
- <div class="section" id="id47">
1712
- <h4>Parameters<a class="headerlink" href="#id47" title="Permalink to this headline">¶</a></h4>
1713
- <table class="colwidths-auto table">
1714
- <thead>
1715
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1716
- <th class="text-align:left head"><p>Type</p></th>
1717
- </tr>
1718
- </thead>
1719
- <tbody>
1720
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1721
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1722
- </tr>
1723
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
1724
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
1725
- </tr>
1726
- </tbody>
1727
- </table>
1728
- </div>
1729
- <div class="section" id="id48">
1730
- <h4>Returns<a class="headerlink" href="#id48" title="Permalink to this headline">¶</a></h4>
1731
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1732
- </div>
1733
- <div class="section" id="id49">
1734
- <h4>Inherited from<a class="headerlink" href="#id49" title="Permalink to this headline">¶</a></h4>
1735
- <p>EventEmitter.off</p>
1736
- </div>
1737
- <div class="section" id="id50">
1738
- <h4>Defined in<a class="headerlink" href="#id50" title="Permalink to this headline">¶</a></h4>
1739
- <p>browser/node_modules/&#64;types/node/events.d.ts:76</p>
1740
- </div>
1741
- </div>
1742
- <hr class="docutils" />
1743
- <div class="section" id="on">
1744
- <h3>on<a class="headerlink" href="#on" title="Permalink to this headline">¶</a></h3>
1745
- <p>▸ <strong>on</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1746
- <div class="section" id="id51">
1747
- <h4>Parameters<a class="headerlink" href="#id51" title="Permalink to this headline">¶</a></h4>
1748
- <table class="colwidths-auto table">
1749
- <thead>
1750
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1751
- <th class="text-align:left head"><p>Type</p></th>
1752
- </tr>
1753
- </thead>
1754
- <tbody>
1755
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1756
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1757
- </tr>
1758
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
1759
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
1760
- </tr>
1761
- </tbody>
1762
- </table>
1763
- </div>
1764
- <div class="section" id="id52">
1765
- <h4>Returns<a class="headerlink" href="#id52" title="Permalink to this headline">¶</a></h4>
1766
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1767
- </div>
1768
- <div class="section" id="id53">
1769
- <h4>Inherited from<a class="headerlink" href="#id53" title="Permalink to this headline">¶</a></h4>
1770
- <p>EventEmitter.on</p>
1771
- </div>
1772
- <div class="section" id="id54">
1773
- <h4>Defined in<a class="headerlink" href="#id54" title="Permalink to this headline">¶</a></h4>
1774
- <p>browser/node_modules/&#64;types/node/events.d.ts:73</p>
1775
- </div>
1776
- </div>
1777
- <hr class="docutils" />
1778
- <div class="section" id="onerror">
1779
- <h3>onError<a class="headerlink" href="#onerror" title="Permalink to this headline">¶</a></h3>
1780
- <p>▸ <strong>onError</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1781
- <p>Register a callback function to be called when a user logs out:</p>
1782
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.11.0</p>
1783
- <div class="section" id="id55">
1784
- <h4>Parameters<a class="headerlink" href="#id55" title="Permalink to this headline">¶</a></h4>
1785
- <table class="colwidths-auto table">
1786
- <thead>
1787
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1788
- <th class="text-align:left head"><p>Type</p></th>
1789
- <th class="text-align:left head"><p>Description</p></th>
1790
- </tr>
1791
- </thead>
1792
- <tbody>
1793
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
1794
- <td class="text-align:left"><p>(<code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">null</span></code> | <code class="docutils literal notranslate"><span class="pre">string</span></code>, <code class="docutils literal notranslate"><span class="pre">errorDescription?</span></code>: <code class="docutils literal notranslate"><span class="pre">null</span></code> | <code class="docutils literal notranslate"><span class="pre">string</span></code>) =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
1795
- <td class="text-align:left"><p>The function called when an error occurs.</p></td>
1796
- </tr>
1797
- </tbody>
1798
- </table>
1799
- </div>
1800
- <div class="section" id="id56">
1801
- <h4>Returns<a class="headerlink" href="#id56" title="Permalink to this headline">¶</a></h4>
1802
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1803
- </div>
1804
- <div class="section" id="id57">
1805
- <h4>Defined in<a class="headerlink" href="#id57" title="Permalink to this headline">¶</a></h4>
1806
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L465">browser/src/Session.ts:465</a></p>
1807
- </div>
1808
- </div>
1809
- <hr class="docutils" />
1810
- <div class="section" id="onlogin">
1811
- <h3>onLogin<a class="headerlink" href="#onlogin" title="Permalink to this headline">¶</a></h3>
1812
- <p>▸ <strong>onLogin</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1813
- <p>Register a callback function to be called when a user completes login.</p>
1814
- <p>The callback is called when <a class="reference external" href="Session.html#handleincomingredirect">handleIncomingRedirect</a> completes successfully.</p>
1815
- <div class="section" id="id58">
1816
- <h4>Parameters<a class="headerlink" href="#id58" title="Permalink to this headline">¶</a></h4>
1817
- <table class="colwidths-auto table">
1818
- <thead>
1819
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1820
- <th class="text-align:left head"><p>Type</p></th>
1821
- <th class="text-align:left head"><p>Description</p></th>
1822
- </tr>
1823
- </thead>
1824
- <tbody>
1825
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
1826
- <td class="text-align:left"><p>() =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
1827
- <td class="text-align:left"><p>The function called when a user completes login.</p></td>
1828
- </tr>
1829
- </tbody>
1830
- </table>
1831
- </div>
1832
- <div class="section" id="id59">
1833
- <h4>Returns<a class="headerlink" href="#id59" title="Permalink to this headline">¶</a></h4>
1834
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1835
- </div>
1836
- <div class="section" id="id60">
1837
- <h4>Defined in<a class="headerlink" href="#id60" title="Permalink to this headline">¶</a></h4>
1838
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L446">browser/src/Session.ts:446</a></p>
1839
- </div>
1840
- </div>
1841
- <hr class="docutils" />
1842
- <div class="section" id="onlogout">
1843
- <h3>onLogout<a class="headerlink" href="#onlogout" title="Permalink to this headline">¶</a></h3>
1844
- <p>▸ <strong>onLogout</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1845
- <p>Register a callback function to be called when a user logs out:</p>
1846
- <div class="section" id="id61">
1847
- <h4>Parameters<a class="headerlink" href="#id61" title="Permalink to this headline">¶</a></h4>
1848
- <table class="colwidths-auto table">
1849
- <thead>
1850
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1851
- <th class="text-align:left head"><p>Type</p></th>
1852
- <th class="text-align:left head"><p>Description</p></th>
1853
- </tr>
1854
- </thead>
1855
- <tbody>
1856
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
1857
- <td class="text-align:left"><p>() =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
1858
- <td class="text-align:left"><p>The function called when a user completes logout.</p></td>
1859
- </tr>
1860
- </tbody>
1861
- </table>
1862
- </div>
1863
- <div class="section" id="id62">
1864
- <h4>Returns<a class="headerlink" href="#id62" title="Permalink to this headline">¶</a></h4>
1865
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1866
- </div>
1867
- <div class="section" id="id63">
1868
- <h4>Defined in<a class="headerlink" href="#id63" title="Permalink to this headline">¶</a></h4>
1869
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L455">browser/src/Session.ts:455</a></p>
1870
- </div>
1871
- </div>
1872
- <hr class="docutils" />
1873
- <div class="section" id="onsessionexpiration">
1874
- <h3>onSessionExpiration<a class="headerlink" href="#onsessionexpiration" title="Permalink to this headline">¶</a></h3>
1875
- <p>▸ <strong>onSessionExpiration</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1876
- <p>Register a callback that runs when the session expires and can no longer
1877
- make authenticated requests, but following a user logout.</p>
1878
- <p><strong><code class="docutils literal notranslate"><span class="pre">since</span></code></strong> 1.11.0</p>
1879
- <div class="section" id="id64">
1880
- <h4>Parameters<a class="headerlink" href="#id64" title="Permalink to this headline">¶</a></h4>
1881
- <table class="colwidths-auto table">
1882
- <thead>
1883
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1884
- <th class="text-align:left head"><p>Type</p></th>
1885
- <th class="text-align:left head"><p>Description</p></th>
1886
- </tr>
1887
- </thead>
1888
- <tbody>
1889
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
1890
- <td class="text-align:left"><p>() =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
1891
- <td class="text-align:left"><p>The function that runs on session expiration.</p></td>
1892
- </tr>
1893
- </tbody>
1894
- </table>
1895
- </div>
1896
- <div class="section" id="id65">
1897
- <h4>Returns<a class="headerlink" href="#id65" title="Permalink to this headline">¶</a></h4>
1898
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1899
- </div>
1900
- <div class="section" id="id66">
1901
- <h4>Defined in<a class="headerlink" href="#id66" title="Permalink to this headline">¶</a></h4>
1902
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L492">browser/src/Session.ts:492</a></p>
1903
- </div>
1904
- </div>
1905
- <hr class="docutils" />
1906
- <div class="section" id="onsessionrestore">
1907
- <h3>onSessionRestore<a class="headerlink" href="#onsessionrestore" title="Permalink to this headline">¶</a></h3>
1908
- <p>▸ <strong>onSessionRestore</strong>(<code class="docutils literal notranslate"><span class="pre">callback</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1909
- <p>Register a callback function to be called when a session is restored.</p>
1910
- <p>Note: the callback will be called with the saved value of the ‘current URL’
1911
- at the time the session was restored.</p>
1912
- <div class="section" id="id67">
1913
- <h4>Parameters<a class="headerlink" href="#id67" title="Permalink to this headline">¶</a></h4>
1914
- <table class="colwidths-auto table">
1915
- <thead>
1916
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1917
- <th class="text-align:left head"><p>Type</p></th>
1918
- <th class="text-align:left head"><p>Description</p></th>
1919
- </tr>
1920
- </thead>
1921
- <tbody>
1922
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">callback</span></code></p></td>
1923
- <td class="text-align:left"><p>(<code class="docutils literal notranslate"><span class="pre">currentUrl</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code>) =&gt; <code class="docutils literal notranslate"><span class="pre">unknown</span></code></p></td>
1924
- <td class="text-align:left"><p>The function called when a user’s already logged-in session is restored, e.g., after a silent authentication is completed after a page refresh.</p></td>
1925
- </tr>
1926
- </tbody>
1927
- </table>
1928
- </div>
1929
- <div class="section" id="id68">
1930
- <h4>Returns<a class="headerlink" href="#id68" title="Permalink to this headline">¶</a></h4>
1931
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
1932
- </div>
1933
- <div class="section" id="id69">
1934
- <h4>Defined in<a class="headerlink" href="#id69" title="Permalink to this headline">¶</a></h4>
1935
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L482">browser/src/Session.ts:482</a></p>
1936
- </div>
1937
- </div>
1938
- <hr class="docutils" />
1939
- <div class="section" id="once">
1940
- <h3>once<a class="headerlink" href="#once" title="Permalink to this headline">¶</a></h3>
1941
- <p>▸ <strong>once</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1942
- <div class="section" id="id70">
1943
- <h4>Parameters<a class="headerlink" href="#id70" title="Permalink to this headline">¶</a></h4>
1944
- <table class="colwidths-auto table">
1945
- <thead>
1946
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1947
- <th class="text-align:left head"><p>Type</p></th>
1948
- </tr>
1949
- </thead>
1950
- <tbody>
1951
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1952
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1953
- </tr>
1954
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
1955
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
1956
- </tr>
1957
- </tbody>
1958
- </table>
1959
- </div>
1960
- <div class="section" id="id71">
1961
- <h4>Returns<a class="headerlink" href="#id71" title="Permalink to this headline">¶</a></h4>
1962
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1963
- </div>
1964
- <div class="section" id="id72">
1965
- <h4>Inherited from<a class="headerlink" href="#id72" title="Permalink to this headline">¶</a></h4>
1966
- <p>EventEmitter.once</p>
1967
- </div>
1968
- <div class="section" id="id73">
1969
- <h4>Defined in<a class="headerlink" href="#id73" title="Permalink to this headline">¶</a></h4>
1970
- <p>browser/node_modules/&#64;types/node/events.d.ts:74</p>
1971
- </div>
1972
- </div>
1973
- <hr class="docutils" />
1974
- <div class="section" id="prependlistener">
1975
- <h3>prependListener<a class="headerlink" href="#prependlistener" title="Permalink to this headline">¶</a></h3>
1976
- <p>▸ <strong>prependListener</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1977
- <div class="section" id="id74">
1978
- <h4>Parameters<a class="headerlink" href="#id74" title="Permalink to this headline">¶</a></h4>
1979
- <table class="colwidths-auto table">
1980
- <thead>
1981
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
1982
- <th class="text-align:left head"><p>Type</p></th>
1983
- </tr>
1984
- </thead>
1985
- <tbody>
1986
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
1987
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
1988
- </tr>
1989
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
1990
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
1991
- </tr>
1992
- </tbody>
1993
- </table>
1994
- </div>
1995
- <div class="section" id="id75">
1996
- <h4>Returns<a class="headerlink" href="#id75" title="Permalink to this headline">¶</a></h4>
1997
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
1998
- </div>
1999
- <div class="section" id="id76">
2000
- <h4>Inherited from<a class="headerlink" href="#id76" title="Permalink to this headline">¶</a></h4>
2001
- <p>EventEmitter.prependListener</p>
2002
- </div>
2003
- <div class="section" id="id77">
2004
- <h4>Defined in<a class="headerlink" href="#id77" title="Permalink to this headline">¶</a></h4>
2005
- <p>browser/node_modules/&#64;types/node/events.d.ts:85</p>
2006
- </div>
2007
- </div>
2008
- <hr class="docutils" />
2009
- <div class="section" id="prependoncelistener">
2010
- <h3>prependOnceListener<a class="headerlink" href="#prependoncelistener" title="Permalink to this headline">¶</a></h3>
2011
- <p>▸ <strong>prependOnceListener</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2012
- <div class="section" id="id78">
2013
- <h4>Parameters<a class="headerlink" href="#id78" title="Permalink to this headline">¶</a></h4>
2014
- <table class="colwidths-auto table">
2015
- <thead>
2016
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2017
- <th class="text-align:left head"><p>Type</p></th>
2018
- </tr>
2019
- </thead>
2020
- <tbody>
2021
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2022
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2023
- </tr>
2024
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
2025
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
2026
- </tr>
2027
- </tbody>
2028
- </table>
2029
- </div>
2030
- <div class="section" id="id79">
2031
- <h4>Returns<a class="headerlink" href="#id79" title="Permalink to this headline">¶</a></h4>
2032
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2033
- </div>
2034
- <div class="section" id="id80">
2035
- <h4>Inherited from<a class="headerlink" href="#id80" title="Permalink to this headline">¶</a></h4>
2036
- <p>EventEmitter.prependOnceListener</p>
2037
- </div>
2038
- <div class="section" id="id81">
2039
- <h4>Defined in<a class="headerlink" href="#id81" title="Permalink to this headline">¶</a></h4>
2040
- <p>browser/node_modules/&#64;types/node/events.d.ts:86</p>
2041
- </div>
2042
- </div>
2043
- <hr class="docutils" />
2044
- <div class="section" id="rawlisteners">
2045
- <h3>rawListeners<a class="headerlink" href="#rawlisteners" title="Permalink to this headline">¶</a></h3>
2046
- <p>▸ <strong>rawListeners</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>): <code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
2047
- <div class="section" id="id82">
2048
- <h4>Parameters<a class="headerlink" href="#id82" title="Permalink to this headline">¶</a></h4>
2049
- <table class="colwidths-auto table">
2050
- <thead>
2051
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2052
- <th class="text-align:left head"><p>Type</p></th>
2053
- </tr>
2054
- </thead>
2055
- <tbody>
2056
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2057
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2058
- </tr>
2059
- </tbody>
2060
- </table>
2061
- </div>
2062
- <div class="section" id="id83">
2063
- <h4>Returns<a class="headerlink" href="#id83" title="Permalink to this headline">¶</a></h4>
2064
- <p><code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
2065
- </div>
2066
- <div class="section" id="id84">
2067
- <h4>Inherited from<a class="headerlink" href="#id84" title="Permalink to this headline">¶</a></h4>
2068
- <p>EventEmitter.rawListeners</p>
2069
- </div>
2070
- <div class="section" id="id85">
2071
- <h4>Defined in<a class="headerlink" href="#id85" title="Permalink to this headline">¶</a></h4>
2072
- <p>browser/node_modules/&#64;types/node/events.d.ts:81</p>
2073
- </div>
2074
- </div>
2075
- <hr class="docutils" />
2076
- <div class="section" id="removealllisteners">
2077
- <h3>removeAllListeners<a class="headerlink" href="#removealllisteners" title="Permalink to this headline">¶</a></h3>
2078
- <p>▸ <strong>removeAllListeners</strong>(<code class="docutils literal notranslate"><span class="pre">event?</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2079
- <div class="section" id="id86">
2080
- <h4>Parameters<a class="headerlink" href="#id86" title="Permalink to this headline">¶</a></h4>
2081
- <table class="colwidths-auto table">
2082
- <thead>
2083
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2084
- <th class="text-align:left head"><p>Type</p></th>
2085
- </tr>
2086
- </thead>
2087
- <tbody>
2088
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event?</span></code></p></td>
2089
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2090
- </tr>
2091
- </tbody>
2092
- </table>
2093
- </div>
2094
- <div class="section" id="id87">
2095
- <h4>Returns<a class="headerlink" href="#id87" title="Permalink to this headline">¶</a></h4>
2096
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2097
- </div>
2098
- <div class="section" id="id88">
2099
- <h4>Inherited from<a class="headerlink" href="#id88" title="Permalink to this headline">¶</a></h4>
2100
- <p>EventEmitter.removeAllListeners</p>
2101
- </div>
2102
- <div class="section" id="id89">
2103
- <h4>Defined in<a class="headerlink" href="#id89" title="Permalink to this headline">¶</a></h4>
2104
- <p>browser/node_modules/&#64;types/node/events.d.ts:77</p>
2105
- </div>
2106
- </div>
2107
- <hr class="docutils" />
2108
- <div class="section" id="removelistener">
2109
- <h3>removeListener<a class="headerlink" href="#removelistener" title="Permalink to this headline">¶</a></h3>
2110
- <p>▸ <strong>removeListener</strong>(<code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">listener</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2111
- <div class="section" id="id90">
2112
- <h4>Parameters<a class="headerlink" href="#id90" title="Permalink to this headline">¶</a></h4>
2113
- <table class="colwidths-auto table">
2114
- <thead>
2115
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2116
- <th class="text-align:left head"><p>Type</p></th>
2117
- </tr>
2118
- </thead>
2119
- <tbody>
2120
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2121
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2122
- </tr>
2123
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">listener</span></code></p></td>
2124
- <td class="text-align:left"><p>(…<code class="docutils literal notranslate"><span class="pre">args</span></code>: <code class="docutils literal notranslate"><span class="pre">any</span></code>[]) =&gt; <code class="docutils literal notranslate"><span class="pre">void</span></code></p></td>
2125
- </tr>
2126
- </tbody>
2127
- </table>
2128
- </div>
2129
- <div class="section" id="id91">
2130
- <h4>Returns<a class="headerlink" href="#id91" title="Permalink to this headline">¶</a></h4>
2131
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2132
- </div>
2133
- <div class="section" id="id92">
2134
- <h4>Inherited from<a class="headerlink" href="#id92" title="Permalink to this headline">¶</a></h4>
2135
- <p>EventEmitter.removeListener</p>
2136
- </div>
2137
- <div class="section" id="id93">
2138
- <h4>Defined in<a class="headerlink" href="#id93" title="Permalink to this headline">¶</a></h4>
2139
- <p>browser/node_modules/&#64;types/node/events.d.ts:75</p>
2140
- </div>
2141
- </div>
2142
- <hr class="docutils" />
2143
- <div class="section" id="setmaxlisteners">
2144
- <h3>setMaxListeners<a class="headerlink" href="#setmaxlisteners" title="Permalink to this headline">¶</a></h3>
2145
- <p>▸ <strong>setMaxListeners</strong>(<code class="docutils literal notranslate"><span class="pre">n</span></code>): <a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2146
- <div class="section" id="id94">
2147
- <h4>Parameters<a class="headerlink" href="#id94" title="Permalink to this headline">¶</a></h4>
2148
- <table class="colwidths-auto table">
2149
- <thead>
2150
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2151
- <th class="text-align:left head"><p>Type</p></th>
2152
- </tr>
2153
- </thead>
2154
- <tbody>
2155
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">n</span></code></p></td>
2156
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">number</span></code></p></td>
2157
- </tr>
2158
- </tbody>
2159
- </table>
2160
- </div>
2161
- <div class="section" id="id95">
2162
- <h4>Returns<a class="headerlink" href="#id95" title="Permalink to this headline">¶</a></h4>
2163
- <p><a class="reference internal" href="#"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">Session</span></code></span></a></p>
2164
- </div>
2165
- <div class="section" id="id96">
2166
- <h4>Inherited from<a class="headerlink" href="#id96" title="Permalink to this headline">¶</a></h4>
2167
- <p>EventEmitter.setMaxListeners</p>
2168
- </div>
2169
- <div class="section" id="id97">
2170
- <h4>Defined in<a class="headerlink" href="#id97" title="Permalink to this headline">¶</a></h4>
2171
- <p>browser/node_modules/&#64;types/node/events.d.ts:78</p>
2172
- </div>
2173
- </div>
2174
- <hr class="docutils" />
2175
- <div class="section" id="setsessioninfo">
2176
- <h3>setSessionInfo<a class="headerlink" href="#setsessioninfo" title="Permalink to this headline">¶</a></h3>
2177
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Private</span></code> <strong>setSessionInfo</strong>(<code class="docutils literal notranslate"><span class="pre">sessionInfo</span></code>): <code class="docutils literal notranslate"><span class="pre">void</span></code></p>
2178
- <div class="section" id="id98">
2179
- <h4>Parameters<a class="headerlink" href="#id98" title="Permalink to this headline">¶</a></h4>
2180
- <table class="colwidths-auto table">
2181
- <thead>
2182
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2183
- <th class="text-align:left head"><p>Type</p></th>
2184
- </tr>
2185
- </thead>
2186
- <tbody>
2187
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">sessionInfo</span></code></p></td>
2188
- <td class="text-align:left"><p><a class="reference internal" href="../interfaces/ISessionInfo.html"><span class="doc std std-doc"><code class="docutils literal notranslate"><span class="pre">ISessionInfo</span></code></span></a> &amp; { <code class="docutils literal notranslate"><span class="pre">isLoggedIn</span></code>: <code class="docutils literal notranslate"><span class="pre">true</span></code> }</p></td>
2189
- </tr>
2190
- </tbody>
2191
- </table>
2192
- </div>
2193
- <div class="section" id="id99">
2194
- <h4>Returns<a class="headerlink" href="#id99" title="Permalink to this headline">¶</a></h4>
2195
- <p><code class="docutils literal notranslate"><span class="pre">void</span></code></p>
2196
- </div>
2197
- <div class="section" id="id100">
2198
- <h4>Defined in<a class="headerlink" href="#id100" title="Permalink to this headline">¶</a></h4>
2199
- <p><a class="reference external" href="https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L496">browser/src/Session.ts:496</a></p>
2200
- </div>
2201
- </div>
2202
- <hr class="docutils" />
2203
- <div class="section" id="geteventlistener">
2204
- <h3>getEventListener<a class="headerlink" href="#geteventlistener" title="Permalink to this headline">¶</a></h3>
2205
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>getEventListener</strong>(<code class="docutils literal notranslate"><span class="pre">emitter</span></code>, <code class="docutils literal notranslate"><span class="pre">name</span></code>): <code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
2206
- <p>Returns a list listener for a specific emitter event name.</p>
2207
- <div class="section" id="id101">
2208
- <h4>Parameters<a class="headerlink" href="#id101" title="Permalink to this headline">¶</a></h4>
2209
- <table class="colwidths-auto table">
2210
- <thead>
2211
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2212
- <th class="text-align:left head"><p>Type</p></th>
2213
- </tr>
2214
- </thead>
2215
- <tbody>
2216
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">emitter</span></code></p></td>
2217
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">DOMEventTarget</span></code> | <code class="docutils literal notranslate"><span class="pre">EventEmitter</span></code></p></td>
2218
- </tr>
2219
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">name</span></code></p></td>
2220
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2221
- </tr>
2222
- </tbody>
2223
- </table>
2224
- </div>
2225
- <div class="section" id="id102">
2226
- <h4>Returns<a class="headerlink" href="#id102" title="Permalink to this headline">¶</a></h4>
2227
- <p><code class="docutils literal notranslate"><span class="pre">Function</span></code>[]</p>
2228
- </div>
2229
- <div class="section" id="id103">
2230
- <h4>Inherited from<a class="headerlink" href="#id103" title="Permalink to this headline">¶</a></h4>
2231
- <p>EventEmitter.getEventListener</p>
2232
- </div>
2233
- <div class="section" id="id104">
2234
- <h4>Defined in<a class="headerlink" href="#id104" title="Permalink to this headline">¶</a></h4>
2235
- <p>browser/node_modules/&#64;types/node/events.d.ts:34</p>
2236
- </div>
2237
- </div>
2238
- <hr class="docutils" />
2239
- <div class="section" id="id105">
2240
- <h3>listenerCount<a class="headerlink" href="#id105" title="Permalink to this headline">¶</a></h3>
2241
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>listenerCount</strong>(<code class="docutils literal notranslate"><span class="pre">emitter</span></code>, <code class="docutils literal notranslate"><span class="pre">event</span></code>): <code class="docutils literal notranslate"><span class="pre">number</span></code></p>
2242
- <p><strong><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></strong> since v4.0.0</p>
2243
- <div class="section" id="id106">
2244
- <h4>Parameters<a class="headerlink" href="#id106" title="Permalink to this headline">¶</a></h4>
2245
- <table class="colwidths-auto table">
2246
- <thead>
2247
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2248
- <th class="text-align:left head"><p>Type</p></th>
2249
- </tr>
2250
- </thead>
2251
- <tbody>
2252
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">emitter</span></code></p></td>
2253
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">EventEmitter</span></code></p></td>
2254
- </tr>
2255
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2256
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2257
- </tr>
2258
- </tbody>
2259
- </table>
2260
- </div>
2261
- <div class="section" id="id107">
2262
- <h4>Returns<a class="headerlink" href="#id107" title="Permalink to this headline">¶</a></h4>
2263
- <p><code class="docutils literal notranslate"><span class="pre">number</span></code></p>
2264
- </div>
2265
- <div class="section" id="id108">
2266
- <h4>Inherited from<a class="headerlink" href="#id108" title="Permalink to this headline">¶</a></h4>
2267
- <p>EventEmitter.listenerCount</p>
2268
- </div>
2269
- <div class="section" id="id109">
2270
- <h4>Defined in<a class="headerlink" href="#id109" title="Permalink to this headline">¶</a></h4>
2271
- <p>browser/node_modules/&#64;types/node/events.d.ts:30</p>
2272
- </div>
2273
- </div>
2274
- <hr class="docutils" />
2275
- <div class="section" id="id110">
2276
- <h3>on<a class="headerlink" href="#id110" title="Permalink to this headline">¶</a></h3>
2277
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>on</strong>(<code class="docutils literal notranslate"><span class="pre">emitter</span></code>, <code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">options?</span></code>): <code class="docutils literal notranslate"><span class="pre">AsyncIterableIterator</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>&gt;</p>
2278
- <div class="section" id="id111">
2279
- <h4>Parameters<a class="headerlink" href="#id111" title="Permalink to this headline">¶</a></h4>
2280
- <table class="colwidths-auto table">
2281
- <thead>
2282
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2283
- <th class="text-align:left head"><p>Type</p></th>
2284
- </tr>
2285
- </thead>
2286
- <tbody>
2287
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">emitter</span></code></p></td>
2288
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">EventEmitter</span></code></p></td>
2289
- </tr>
2290
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2291
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
2292
- </tr>
2293
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">options?</span></code></p></td>
2294
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">StaticEventEmitterOptions</span></code></p></td>
2295
- </tr>
2296
- </tbody>
2297
- </table>
2298
- </div>
2299
- <div class="section" id="id112">
2300
- <h4>Returns<a class="headerlink" href="#id112" title="Permalink to this headline">¶</a></h4>
2301
- <p><code class="docutils literal notranslate"><span class="pre">AsyncIterableIterator</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>&gt;</p>
2302
- </div>
2303
- <div class="section" id="id113">
2304
- <h4>Inherited from<a class="headerlink" href="#id113" title="Permalink to this headline">¶</a></h4>
2305
- <p>EventEmitter.on</p>
2306
- </div>
2307
- <div class="section" id="id114">
2308
- <h4>Defined in<a class="headerlink" href="#id114" title="Permalink to this headline">¶</a></h4>
2309
- <p>browser/node_modules/&#64;types/node/events.d.ts:27</p>
2310
- </div>
2311
- </div>
2312
- <hr class="docutils" />
2313
- <div class="section" id="id115">
2314
- <h3>once<a class="headerlink" href="#id115" title="Permalink to this headline">¶</a></h3>
2315
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>once</strong>(<code class="docutils literal notranslate"><span class="pre">emitter</span></code>, <code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">options?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>[]&gt;</p>
2316
- <div class="section" id="id116">
2317
- <h4>Parameters<a class="headerlink" href="#id116" title="Permalink to this headline">¶</a></h4>
2318
- <table class="colwidths-auto table">
2319
- <thead>
2320
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2321
- <th class="text-align:left head"><p>Type</p></th>
2322
- </tr>
2323
- </thead>
2324
- <tbody>
2325
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">emitter</span></code></p></td>
2326
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">NodeEventTarget</span></code></p></td>
2327
- </tr>
2328
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2329
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code> | <code class="docutils literal notranslate"><span class="pre">symbol</span></code></p></td>
2330
- </tr>
2331
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">options?</span></code></p></td>
2332
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">StaticEventEmitterOptions</span></code></p></td>
2333
- </tr>
2334
- </tbody>
2335
- </table>
2336
- </div>
2337
- <div class="section" id="id117">
2338
- <h4>Returns<a class="headerlink" href="#id117" title="Permalink to this headline">¶</a></h4>
2339
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>[]&gt;</p>
2340
- </div>
2341
- <div class="section" id="id118">
2342
- <h4>Inherited from<a class="headerlink" href="#id118" title="Permalink to this headline">¶</a></h4>
2343
- <p>EventEmitter.once</p>
2344
- </div>
2345
- <div class="section" id="id119">
2346
- <h4>Defined in<a class="headerlink" href="#id119" title="Permalink to this headline">¶</a></h4>
2347
- <p>browser/node_modules/&#64;types/node/events.d.ts:25</p>
2348
- <p>▸ <code class="docutils literal notranslate"><span class="pre">Static</span></code> <strong>once</strong>(<code class="docutils literal notranslate"><span class="pre">emitter</span></code>, <code class="docutils literal notranslate"><span class="pre">event</span></code>, <code class="docutils literal notranslate"><span class="pre">options?</span></code>): <code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>[]&gt;</p>
2349
- </div>
2350
- <div class="section" id="id120">
2351
- <h4>Parameters<a class="headerlink" href="#id120" title="Permalink to this headline">¶</a></h4>
2352
- <table class="colwidths-auto table">
2353
- <thead>
2354
- <tr class="row-odd"><th class="text-align:left head"><p>Name</p></th>
2355
- <th class="text-align:left head"><p>Type</p></th>
2356
- </tr>
2357
- </thead>
2358
- <tbody>
2359
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">emitter</span></code></p></td>
2360
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">DOMEventTarget</span></code></p></td>
2361
- </tr>
2362
- <tr class="row-odd"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">event</span></code></p></td>
2363
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
2364
- </tr>
2365
- <tr class="row-even"><td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">options?</span></code></p></td>
2366
- <td class="text-align:left"><p><code class="docutils literal notranslate"><span class="pre">StaticEventEmitterOptions</span></code></p></td>
2367
- </tr>
2368
- </tbody>
2369
- </table>
2370
- </div>
2371
- <div class="section" id="id121">
2372
- <h4>Returns<a class="headerlink" href="#id121" title="Permalink to this headline">¶</a></h4>
2373
- <p><code class="docutils literal notranslate"><span class="pre">Promise</span></code>&lt;<code class="docutils literal notranslate"><span class="pre">any</span></code>[]&gt;</p>
2374
- </div>
2375
- <div class="section" id="id122">
2376
- <h4>Inherited from<a class="headerlink" href="#id122" title="Permalink to this headline">¶</a></h4>
2377
- <p>EventEmitter.once</p>
2378
- </div>
2379
- <div class="section" id="id123">
2380
- <h4>Defined in<a class="headerlink" href="#id123" title="Permalink to this headline">¶</a></h4>
2381
- <p>browser/node_modules/&#64;types/node/events.d.ts:26</p>
2382
- </div>
2383
- </div>
2384
- </div>
2385
- </div>
2386
-
2387
-
2388
- </div>
2389
-
2390
-
2391
-
2392
-
2393
- <!-- Previous / next buttons -->
2394
- <div class='prev-next-area'>
2395
- <a class='left-prev' id="prev-link" href="NotImplementedError.html" title="previous page">
2396
- <i class="fas fa-angle-left"></i>
2397
- <div class="prev-next-info">
2398
- <p class="prev-next-title">Class: NotImplementedError</p>
2399
- </div>
2400
- </a>
2401
- <a class='right-next' id="next-link" href="../functions.html" title="next page">
2402
- <div class="prev-next-info">
2403
- <p class="prev-next-title">Functions</p>
2404
- </div>
2405
- <i class="fas fa-angle-right"></i>
2406
- </a>
2407
- </div>
2408
-
2409
- </main>
2410
-
2411
-
2412
- </div>
2413
- </div>
2414
-
2415
- <script src="../_static/js/index.be7d3bbb2ef33a8344ce.js"></script>
2416
- <footer class="footer mt-5 mt-md-0">
2417
- <div class="container">
2418
-
2419
- <div class="footer-item">
2420
- <div class="container">
2421
- <p>&copy; 2021 Inrupt Inc. </p>
2422
- </div>
2423
- </div>
2424
-
2425
- </div>
2426
- </footer>
2427
- </body>
2428
- </html>