@rxap/config 19.3.0-dev.4 → 21.0.1-dev.0
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.
- package/CHANGELOG.md +20 -0
- package/compodoc/changelog.html +26 -0
- package/compodoc/dependencies.html +6 -6
- package/compodoc/index.html +69 -1
- package/compodoc/injectables/ConfigService.html +210 -102
- package/compodoc/interfaces/ConfigLoadError.html +610 -0
- package/compodoc/interfaces/ConfigLoadOptions.html +213 -66
- package/compodoc/js/menu-wc.js +3 -0
- package/compodoc/js/menu-wc_es5.js +1 -1
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/miscellaneous/functions.html +130 -1
- package/compodoc/miscellaneous/typealiases.html +78 -0
- package/compodoc/overview.html +1 -1
- package/compodoc/properties.html +1 -1
- package/docs/documentation.json +2445 -1297
- package/docs/html/assets/hierarchy.js +1 -1
- package/docs/html/assets/highlight.css +42 -0
- package/docs/html/assets/navigation.js +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/ConfigLoaderService.html +2 -2
- package/docs/html/classes/ConfigService.html +8 -6
- package/docs/html/classes/ConfigTestingService.html +2 -2
- package/docs/html/enums/ConfigLoadMethod.html +2 -2
- package/docs/html/enums/ConfigLoadingStrategy.html +2 -2
- package/docs/html/functions/ProvideConfig.html +1 -1
- package/docs/html/functions/defaultConfigLoadErrorHandler.html +4 -0
- package/docs/html/functions/dnsLookup.html +1 -1
- package/docs/html/functions/dnsResolver.html +1 -1
- package/docs/html/functions/fetchCidContent.html +1 -1
- package/docs/html/functions/fetchCidContentAsJson.html +1 -1
- package/docs/html/functions/fetchCidContentViaHttp.html +1 -1
- package/docs/html/functions/fetchContentViaHttp.html +1 -1
- package/docs/html/functions/localPathIpfsGateway.html +1 -1
- package/docs/html/functions/localSubDomainIpfsGateway.html +1 -1
- package/docs/html/functions/raceSuccess.html +2 -2
- package/docs/html/functions/showConfigLoadError.html +2 -0
- package/docs/html/functions/storachaIpfsGateway.html +1 -1
- package/docs/html/functions/w3sIpfsGateway.html +1 -1
- package/docs/html/hierarchy.html +1 -1
- package/docs/html/index.html +54 -2
- package/docs/html/interfaces/AppsNavigationConfig.html +2 -2
- package/docs/html/interfaces/Config.html +2 -2
- package/docs/html/interfaces/ConfigLoadError.html +11 -0
- package/docs/html/interfaces/ConfigLoadOptions.html +13 -6
- package/docs/html/interfaces/LogoConfig.html +2 -2
- package/docs/html/interfaces/NavigationConfig.html +2 -2
- package/docs/html/interfaces/Oauth2Config.html +2 -2
- package/docs/html/interfaces/i18nConfig.html +2 -2
- package/docs/html/modules.html +1 -1
- package/docs/html/types/AnySchema.html +1 -1
- package/docs/html/types/ConfigLoadErrorHandler.html +2 -0
- package/docs/html/types/ConfigLoadErrorKind.html +9 -0
- package/docs/html/types/ConfigRequestOptions.html +1 -0
- package/docs/html/types/IpfsGatewayFunction.html +1 -1
- package/docs/html/types/Join.html +1 -1
- package/docs/html/types/LanguagesConfig.html +1 -1
- package/docs/html/types/Leaves.html +1 -1
- package/docs/html/types/NoInferType.html +1 -1
- package/docs/html/types/Paths.html +1 -1
- package/docs/html/variables/RXAP_CONFIG.html +1 -1
- package/docs/html/variables/defaultDnsServers.html +1 -1
- package/docs/html/variables/defaultIpfsGatewayServers.html +1 -1
- package/docs/markdown/README.md +54 -1
- package/docs/markdown/classes/ConfigLoaderService.md +7 -7
- package/docs/markdown/classes/ConfigService.md +37 -23
- package/docs/markdown/classes/ConfigTestingService.md +8 -8
- package/docs/markdown/enumerations/ConfigLoadMethod.md +6 -6
- package/docs/markdown/enumerations/ConfigLoadingStrategy.md +4 -4
- package/docs/markdown/functions/ProvideConfig.md +2 -2
- package/docs/markdown/functions/defaultConfigLoadErrorHandler.md +26 -0
- package/docs/markdown/functions/dnsLookup.md +2 -2
- package/docs/markdown/functions/dnsResolver.md +2 -2
- package/docs/markdown/functions/fetchCidContent.md +2 -2
- package/docs/markdown/functions/fetchCidContentAsJson.md +2 -2
- package/docs/markdown/functions/fetchCidContentViaHttp.md +2 -2
- package/docs/markdown/functions/fetchContentViaHttp.md +2 -2
- package/docs/markdown/functions/localPathIpfsGateway.md +2 -2
- package/docs/markdown/functions/localSubDomainIpfsGateway.md +2 -2
- package/docs/markdown/functions/raceSuccess.md +2 -2
- package/docs/markdown/functions/showConfigLoadError.md +23 -0
- package/docs/markdown/functions/storachaIpfsGateway.md +2 -2
- package/docs/markdown/functions/w3sIpfsGateway.md +2 -2
- package/docs/markdown/globals.md +8 -2
- package/docs/markdown/interfaces/AppsNavigationConfig.md +12 -12
- package/docs/markdown/interfaces/Config.md +6 -6
- package/docs/markdown/interfaces/ConfigLoadError.md +70 -0
- package/docs/markdown/interfaces/ConfigLoadOptions.md +39 -15
- package/docs/markdown/interfaces/LogoConfig.md +5 -5
- package/docs/markdown/interfaces/NavigationConfig.md +9 -9
- package/docs/markdown/interfaces/Oauth2Config.md +3 -3
- package/docs/markdown/interfaces/i18nConfig.md +4 -4
- package/docs/markdown/type-aliases/AnySchema.md +2 -2
- package/docs/markdown/type-aliases/ConfigLoadErrorHandler.md +23 -0
- package/docs/markdown/type-aliases/ConfigLoadErrorKind.md +19 -0
- package/docs/markdown/type-aliases/ConfigRequestOptions.md +11 -0
- package/docs/markdown/type-aliases/IpfsGatewayFunction.md +2 -2
- package/docs/markdown/type-aliases/Join.md +2 -2
- package/docs/markdown/type-aliases/LanguagesConfig.md +2 -2
- package/docs/markdown/type-aliases/Leaves.md +2 -2
- package/docs/markdown/type-aliases/NoInferType.md +2 -2
- package/docs/markdown/type-aliases/Paths.md +2 -2
- package/docs/markdown/variables/RXAP_CONFIG.md +2 -2
- package/docs/markdown/variables/defaultDnsServers.md +2 -2
- package/docs/markdown/variables/defaultIpfsGatewayServers.md +2 -2
- package/docs/wiki/Class.ConfigLoaderService.md +6 -6
- package/docs/wiki/Class.ConfigService.md +36 -22
- package/docs/wiki/Class.ConfigTestingService.md +7 -7
- package/docs/wiki/Enumeration.ConfigLoadMethod.md +5 -5
- package/docs/wiki/Enumeration.ConfigLoadingStrategy.md +3 -3
- package/docs/wiki/Function.ProvideConfig.md +1 -1
- package/docs/wiki/Function.defaultConfigLoadErrorHandler.md +22 -0
- package/docs/wiki/Function.dnsLookup.md +1 -1
- package/docs/wiki/Function.dnsResolver.md +1 -1
- package/docs/wiki/Function.fetchCidContent.md +1 -1
- package/docs/wiki/Function.fetchCidContentAsJson.md +1 -1
- package/docs/wiki/Function.fetchCidContentViaHttp.md +1 -1
- package/docs/wiki/Function.fetchContentViaHttp.md +1 -1
- package/docs/wiki/Function.localPathIpfsGateway.md +1 -1
- package/docs/wiki/Function.localSubDomainIpfsGateway.md +1 -1
- package/docs/wiki/Function.raceSuccess.md +1 -1
- package/docs/wiki/Function.showConfigLoadError.md +19 -0
- package/docs/wiki/Function.storachaIpfsGateway.md +1 -1
- package/docs/wiki/Function.w3sIpfsGateway.md +1 -1
- package/docs/wiki/Home.md +53 -0
- package/docs/wiki/Interface.AppsNavigationConfig.md +11 -11
- package/docs/wiki/Interface.Config.md +5 -5
- package/docs/wiki/Interface.ConfigLoadError.md +66 -0
- package/docs/wiki/Interface.ConfigLoadOptions.md +38 -14
- package/docs/wiki/Interface.LogoConfig.md +4 -4
- package/docs/wiki/Interface.NavigationConfig.md +8 -8
- package/docs/wiki/Interface.Oauth2Config.md +2 -2
- package/docs/wiki/Interface.i18nConfig.md +3 -3
- package/docs/wiki/TypeAlias.AnySchema.md +1 -1
- package/docs/wiki/TypeAlias.ConfigLoadErrorHandler.md +19 -0
- package/docs/wiki/TypeAlias.ConfigLoadErrorKind.md +15 -0
- package/docs/wiki/TypeAlias.ConfigRequestOptions.md +7 -0
- package/docs/wiki/TypeAlias.IpfsGatewayFunction.md +1 -1
- package/docs/wiki/TypeAlias.Join.md +1 -1
- package/docs/wiki/TypeAlias.LanguagesConfig.md +1 -1
- package/docs/wiki/TypeAlias.Leaves.md +1 -1
- package/docs/wiki/TypeAlias.NoInferType.md +1 -1
- package/docs/wiki/TypeAlias.Paths.md +1 -1
- package/docs/wiki/Variable.RXAP_CONFIG.md +1 -1
- package/docs/wiki/Variable.defaultDnsServers.md +1 -1
- package/docs/wiki/Variable.defaultIpfsGatewayServers.md +1 -1
- package/docs/wiki/_Sidebar.md +6 -0
- package/docs/wiki/globals.md +7 -1
- package/fesm2022/rxap-config.mjs +10 -10
- package/fesm2022/rxap-config.mjs.map +1 -1
- package/package.json +15 -14
- package/types/rxap-config.d.ts +298 -0
- package/index.d.ts +0 -9
- package/lib/config-load-error.d.ts +0 -41
- package/lib/config-loader.service.d.ts +0 -12
- package/lib/config-testing-service.d.ts +0 -12
- package/lib/config.d.ts +0 -41
- package/lib/config.service.d.ts +0 -129
- package/lib/provide-config.d.ts +0 -4
- package/lib/tokens.d.ts +0 -2
- package/lib/types.d.ts +0 -34
- package/lib/utilities.d.ts +0 -19
|
@@ -0,0 +1,610 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="no-js" lang="">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
6
|
+
<title>angular-config</title>
|
|
7
|
+
<meta name="description" content="">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
|
|
10
|
+
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
|
|
11
|
+
<link rel="stylesheet" href="../styles/style.css">
|
|
12
|
+
<link rel="stylesheet" href="../styles/dark.css">
|
|
13
|
+
</head>
|
|
14
|
+
<body>
|
|
15
|
+
<script>
|
|
16
|
+
// Blocking script to avoid flickering dark mode
|
|
17
|
+
// Dark mode toggle button
|
|
18
|
+
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
|
|
19
|
+
var darkModeState = useDark.matches;
|
|
20
|
+
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
21
|
+
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
|
|
22
|
+
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
|
|
23
|
+
|
|
24
|
+
function checkToggle(check) {
|
|
25
|
+
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
26
|
+
$darkModeToggleSwitchers[i].checked = check;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function toggleDarkMode(state) {
|
|
31
|
+
if (window.localStorage) {
|
|
32
|
+
localStorage.setItem('compodoc_darkmode-state', state);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
checkToggle(state);
|
|
36
|
+
|
|
37
|
+
const hasClass = document.body.classList.contains('dark');
|
|
38
|
+
|
|
39
|
+
if (state) {
|
|
40
|
+
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
41
|
+
$darkModeToggles[i].classList.add('dark');
|
|
42
|
+
}
|
|
43
|
+
if (!hasClass) {
|
|
44
|
+
document.body.classList.add('dark');
|
|
45
|
+
}
|
|
46
|
+
} else {
|
|
47
|
+
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
48
|
+
$darkModeToggles[i].classList.remove('dark');
|
|
49
|
+
}
|
|
50
|
+
if (hasClass) {
|
|
51
|
+
document.body.classList.remove('dark');
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
useDark.addEventListener('change', function (evt) {
|
|
57
|
+
toggleDarkMode(evt.matches);
|
|
58
|
+
});
|
|
59
|
+
if (darkModeStateLocal) {
|
|
60
|
+
darkModeState = darkModeStateLocal === 'true';
|
|
61
|
+
}
|
|
62
|
+
toggleDarkMode(darkModeState);
|
|
63
|
+
</script>
|
|
64
|
+
|
|
65
|
+
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
|
|
66
|
+
<div class="d-flex">
|
|
67
|
+
<a href="../" class="navbar-brand">angular-config</a>
|
|
68
|
+
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
|
69
|
+
</div>
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
<div class="xs-menu menu" id="mobile-menu">
|
|
73
|
+
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
|
74
|
+
</div>
|
|
75
|
+
|
|
76
|
+
<div class="container-fluid main">
|
|
77
|
+
<div class="row main">
|
|
78
|
+
<div class="d-none d-md-block menu">
|
|
79
|
+
<compodoc-menu mode="normal"></compodoc-menu>
|
|
80
|
+
</div>
|
|
81
|
+
<!-- START CONTENT -->
|
|
82
|
+
<div class="content interface">
|
|
83
|
+
<div class="content-data">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<ol class="breadcrumb">
|
|
98
|
+
<li class="breadcrumb-item">Interfaces</li>
|
|
99
|
+
<li class="breadcrumb-item"
|
|
100
|
+
>
|
|
101
|
+
ConfigLoadError</li>
|
|
102
|
+
</ol>
|
|
103
|
+
|
|
104
|
+
<ul class="nav nav-tabs" role="tablist">
|
|
105
|
+
<li class="nav-item">
|
|
106
|
+
<a href="#info"
|
|
107
|
+
class="nav-link"
|
|
108
|
+
class="nav-link active"
|
|
109
|
+
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
|
|
110
|
+
</li>
|
|
111
|
+
<li class="nav-item">
|
|
112
|
+
<a href="#source"
|
|
113
|
+
class="nav-link"
|
|
114
|
+
|
|
115
|
+
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
|
|
116
|
+
</li>
|
|
117
|
+
</ul>
|
|
118
|
+
|
|
119
|
+
<div class="tab-content">
|
|
120
|
+
<div class="tab-pane fade active in" id="info">
|
|
121
|
+
<p class="comment">
|
|
122
|
+
<h3>File</h3>
|
|
123
|
+
</p>
|
|
124
|
+
<p class="comment">
|
|
125
|
+
<code>src/lib/config-load-error.ts</code>
|
|
126
|
+
</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<section data-compodoc="block-index">
|
|
132
|
+
<h3 id="index">Index</h3>
|
|
133
|
+
<table class="table table-sm table-bordered index-table">
|
|
134
|
+
<tbody>
|
|
135
|
+
<tr>
|
|
136
|
+
<td class="col-md-4">
|
|
137
|
+
<h6><b>Properties</b></h6>
|
|
138
|
+
</td>
|
|
139
|
+
</tr>
|
|
140
|
+
<tr>
|
|
141
|
+
<td class="col-md-4">
|
|
142
|
+
<ul class="index-list">
|
|
143
|
+
<li>
|
|
144
|
+
<span class="modifier">Optional</span>
|
|
145
|
+
<a href="#cause"
|
|
146
|
+
>
|
|
147
|
+
cause
|
|
148
|
+
</a>
|
|
149
|
+
</li>
|
|
150
|
+
<li>
|
|
151
|
+
<a href="#kind"
|
|
152
|
+
>
|
|
153
|
+
kind
|
|
154
|
+
</a>
|
|
155
|
+
</li>
|
|
156
|
+
<li>
|
|
157
|
+
<a href="#message"
|
|
158
|
+
>
|
|
159
|
+
message
|
|
160
|
+
</a>
|
|
161
|
+
</li>
|
|
162
|
+
<li>
|
|
163
|
+
<a href="#required"
|
|
164
|
+
>
|
|
165
|
+
required
|
|
166
|
+
</a>
|
|
167
|
+
</li>
|
|
168
|
+
<li>
|
|
169
|
+
<span class="modifier">Optional</span>
|
|
170
|
+
<a href="#response"
|
|
171
|
+
>
|
|
172
|
+
response
|
|
173
|
+
</a>
|
|
174
|
+
</li>
|
|
175
|
+
<li>
|
|
176
|
+
<span class="modifier">Optional</span>
|
|
177
|
+
<a href="#status"
|
|
178
|
+
>
|
|
179
|
+
status
|
|
180
|
+
</a>
|
|
181
|
+
</li>
|
|
182
|
+
<li>
|
|
183
|
+
<a href="#url"
|
|
184
|
+
>
|
|
185
|
+
url
|
|
186
|
+
</a>
|
|
187
|
+
</li>
|
|
188
|
+
</ul>
|
|
189
|
+
</td>
|
|
190
|
+
</tr>
|
|
191
|
+
</tbody>
|
|
192
|
+
</table>
|
|
193
|
+
</section>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<section data-compodoc="block-properties">
|
|
198
|
+
<h3 id="inputs">Properties</h3>
|
|
199
|
+
<table class="table table-sm table-bordered">
|
|
200
|
+
<tbody>
|
|
201
|
+
<tr>
|
|
202
|
+
<td class="col-md-4">
|
|
203
|
+
<a name="cause"></a>
|
|
204
|
+
<span class="name "><b>cause</b>
|
|
205
|
+
<a href="#cause">
|
|
206
|
+
<span class="icon ion-ios-link"></span>
|
|
207
|
+
</a>
|
|
208
|
+
</span>
|
|
209
|
+
</td>
|
|
210
|
+
</tr>
|
|
211
|
+
<tr>
|
|
212
|
+
<td class="col-md-4">
|
|
213
|
+
<code>cause: <code></code>
|
|
214
|
+
</code>
|
|
215
|
+
</td>
|
|
216
|
+
</tr>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<tr>
|
|
221
|
+
<td class="col-md-4">
|
|
222
|
+
<i>Optional</i>
|
|
223
|
+
</td>
|
|
224
|
+
</tr>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
</tbody>
|
|
230
|
+
</table>
|
|
231
|
+
<table class="table table-sm table-bordered">
|
|
232
|
+
<tbody>
|
|
233
|
+
<tr>
|
|
234
|
+
<td class="col-md-4">
|
|
235
|
+
<a name="kind"></a>
|
|
236
|
+
<span class="name "><b>kind</b>
|
|
237
|
+
<a href="#kind">
|
|
238
|
+
<span class="icon ion-ios-link"></span>
|
|
239
|
+
</a>
|
|
240
|
+
</span>
|
|
241
|
+
</td>
|
|
242
|
+
</tr>
|
|
243
|
+
<tr>
|
|
244
|
+
<td class="col-md-4">
|
|
245
|
+
<code>kind: <code><a href="../miscellaneous/typealiases.html#ConfigLoadErrorKind" target="_self" >ConfigLoadErrorKind</a></code>
|
|
246
|
+
</code>
|
|
247
|
+
</td>
|
|
248
|
+
</tr>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<tr>
|
|
252
|
+
<td class="col-md-4">
|
|
253
|
+
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#ConfigLoadErrorKind" target="_self" >ConfigLoadErrorKind</a></code>
|
|
254
|
+
|
|
255
|
+
</td>
|
|
256
|
+
</tr>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</tbody>
|
|
263
|
+
</table>
|
|
264
|
+
<table class="table table-sm table-bordered">
|
|
265
|
+
<tbody>
|
|
266
|
+
<tr>
|
|
267
|
+
<td class="col-md-4">
|
|
268
|
+
<a name="message"></a>
|
|
269
|
+
<span class="name "><b>message</b>
|
|
270
|
+
<a href="#message">
|
|
271
|
+
<span class="icon ion-ios-link"></span>
|
|
272
|
+
</a>
|
|
273
|
+
</span>
|
|
274
|
+
</td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td class="col-md-4">
|
|
278
|
+
<code>message: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
279
|
+
</code>
|
|
280
|
+
</td>
|
|
281
|
+
</tr>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<tr>
|
|
285
|
+
<td class="col-md-4">
|
|
286
|
+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
287
|
+
|
|
288
|
+
</td>
|
|
289
|
+
</tr>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<tr>
|
|
296
|
+
<td class="col-md-4">
|
|
297
|
+
<div class="io-description"><p>The message the default handler would show.</p>
|
|
298
|
+
</div>
|
|
299
|
+
</td>
|
|
300
|
+
</tr>
|
|
301
|
+
</tbody>
|
|
302
|
+
</table>
|
|
303
|
+
<table class="table table-sm table-bordered">
|
|
304
|
+
<tbody>
|
|
305
|
+
<tr>
|
|
306
|
+
<td class="col-md-4">
|
|
307
|
+
<a name="required"></a>
|
|
308
|
+
<span class="name "><b>required</b>
|
|
309
|
+
<a href="#required">
|
|
310
|
+
<span class="icon ion-ios-link"></span>
|
|
311
|
+
</a>
|
|
312
|
+
</span>
|
|
313
|
+
</td>
|
|
314
|
+
</tr>
|
|
315
|
+
<tr>
|
|
316
|
+
<td class="col-md-4">
|
|
317
|
+
<code>required: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
|
|
318
|
+
</code>
|
|
319
|
+
</td>
|
|
320
|
+
</tr>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<tr>
|
|
324
|
+
<td class="col-md-4">
|
|
325
|
+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
|
|
326
|
+
|
|
327
|
+
</td>
|
|
328
|
+
</tr>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<tr>
|
|
335
|
+
<td class="col-md-4">
|
|
336
|
+
<div class="io-description"><p>true if the config url is required. A required url throws after the error handler is called,
|
|
337
|
+
an optional url resolves with <code>null</code>.</p>
|
|
338
|
+
</div>
|
|
339
|
+
</td>
|
|
340
|
+
</tr>
|
|
341
|
+
</tbody>
|
|
342
|
+
</table>
|
|
343
|
+
<table class="table table-sm table-bordered">
|
|
344
|
+
<tbody>
|
|
345
|
+
<tr>
|
|
346
|
+
<td class="col-md-4">
|
|
347
|
+
<a name="response"></a>
|
|
348
|
+
<span class="name "><b>response</b>
|
|
349
|
+
<a href="#response">
|
|
350
|
+
<span class="icon ion-ios-link"></span>
|
|
351
|
+
</a>
|
|
352
|
+
</span>
|
|
353
|
+
</td>
|
|
354
|
+
</tr>
|
|
355
|
+
<tr>
|
|
356
|
+
<td class="col-md-4">
|
|
357
|
+
<code>response: <code>Response</code>
|
|
358
|
+
</code>
|
|
359
|
+
</td>
|
|
360
|
+
</tr>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<tr>
|
|
364
|
+
<td class="col-md-4">
|
|
365
|
+
<i>Type : </i> <code>Response</code>
|
|
366
|
+
|
|
367
|
+
</td>
|
|
368
|
+
</tr>
|
|
369
|
+
|
|
370
|
+
<tr>
|
|
371
|
+
<td class="col-md-4">
|
|
372
|
+
<i>Optional</i>
|
|
373
|
+
</td>
|
|
374
|
+
</tr>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
</tbody>
|
|
380
|
+
</table>
|
|
381
|
+
<table class="table table-sm table-bordered">
|
|
382
|
+
<tbody>
|
|
383
|
+
<tr>
|
|
384
|
+
<td class="col-md-4">
|
|
385
|
+
<a name="status"></a>
|
|
386
|
+
<span class="name "><b>status</b>
|
|
387
|
+
<a href="#status">
|
|
388
|
+
<span class="icon ion-ios-link"></span>
|
|
389
|
+
</a>
|
|
390
|
+
</span>
|
|
391
|
+
</td>
|
|
392
|
+
</tr>
|
|
393
|
+
<tr>
|
|
394
|
+
<td class="col-md-4">
|
|
395
|
+
<code>status: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
|
|
396
|
+
</code>
|
|
397
|
+
</td>
|
|
398
|
+
</tr>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<tr>
|
|
402
|
+
<td class="col-md-4">
|
|
403
|
+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
|
|
404
|
+
|
|
405
|
+
</td>
|
|
406
|
+
</tr>
|
|
407
|
+
|
|
408
|
+
<tr>
|
|
409
|
+
<td class="col-md-4">
|
|
410
|
+
<i>Optional</i>
|
|
411
|
+
</td>
|
|
412
|
+
</tr>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
</tbody>
|
|
418
|
+
</table>
|
|
419
|
+
<table class="table table-sm table-bordered">
|
|
420
|
+
<tbody>
|
|
421
|
+
<tr>
|
|
422
|
+
<td class="col-md-4">
|
|
423
|
+
<a name="url"></a>
|
|
424
|
+
<span class="name "><b>url</b>
|
|
425
|
+
<a href="#url">
|
|
426
|
+
<span class="icon ion-ios-link"></span>
|
|
427
|
+
</a>
|
|
428
|
+
</span>
|
|
429
|
+
</td>
|
|
430
|
+
</tr>
|
|
431
|
+
<tr>
|
|
432
|
+
<td class="col-md-4">
|
|
433
|
+
<code>url: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
434
|
+
</code>
|
|
435
|
+
</td>
|
|
436
|
+
</tr>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<tr>
|
|
440
|
+
<td class="col-md-4">
|
|
441
|
+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
|
|
442
|
+
|
|
443
|
+
</td>
|
|
444
|
+
</tr>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</tbody>
|
|
451
|
+
</table>
|
|
452
|
+
</section>
|
|
453
|
+
</div>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<div class="tab-pane fade tab-source-code" id="source">
|
|
457
|
+
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">export type ConfigLoadErrorKind =
|
|
458
|
+
| 'network'
|
|
459
|
+
| 'redirect'
|
|
460
|
+
| 'http'
|
|
461
|
+
| 'parse'
|
|
462
|
+
| 'schema';
|
|
463
|
+
|
|
464
|
+
export interface ConfigLoadError {
|
|
465
|
+
kind: ConfigLoadErrorKind;
|
|
466
|
+
url: string;
|
|
467
|
+
/**
|
|
468
|
+
* true if the config url is required. A required url throws after the error handler is called,
|
|
469
|
+
* an optional url resolves with `null`.
|
|
470
|
+
*/
|
|
471
|
+
required: boolean;
|
|
472
|
+
status?: number;
|
|
473
|
+
response?: Response;
|
|
474
|
+
cause?: unknown;
|
|
475
|
+
/**
|
|
476
|
+
* The message the default handler would show.
|
|
477
|
+
*/
|
|
478
|
+
message: string;
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Called for every failed config url request. May never resolve, e.g. if it navigates away.
|
|
483
|
+
*/
|
|
484
|
+
export type ConfigLoadErrorHandler = (error: ConfigLoadError) => void | Promise<void>;
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* The default config load error handler. Shows the error message in an overlay and reloads the
|
|
488
|
+
* page after 30 s for required config urls. Logs a warning for optional config urls.
|
|
489
|
+
*
|
|
490
|
+
* Can be used as fallback in a custom error handler for error kinds it does not handle.
|
|
491
|
+
*/
|
|
492
|
+
export function defaultConfigLoadErrorHandler(error: ConfigLoadError): void {
|
|
493
|
+
if (error.required) {
|
|
494
|
+
showConfigLoadError(error.message);
|
|
495
|
+
} else {
|
|
496
|
+
console.warn(error.message);
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* Appends the message to the config error overlay and schedules a page reload in 30 s.
|
|
502
|
+
*/
|
|
503
|
+
export function showConfigLoadError(message: string) {
|
|
504
|
+
const hasUl = document.getElementById('rxap-config-error') !== null;
|
|
505
|
+
const ul = document.getElementById('rxap-config-error') ?? document.createElement('ul');
|
|
506
|
+
ul.id = 'rxap-config-error';
|
|
507
|
+
ul.style.position = 'fixed';
|
|
508
|
+
ul.style.bottom = '16px';
|
|
509
|
+
ul.style.right = '16px';
|
|
510
|
+
ul.style.backgroundColor = 'white';
|
|
511
|
+
ul.style.padding = '32px';
|
|
512
|
+
ul.style.zIndex = '99999999';
|
|
513
|
+
ul.style.color = 'black';
|
|
514
|
+
const messageLi = document.createElement('li');
|
|
515
|
+
messageLi.innerText = message;
|
|
516
|
+
ul.appendChild(messageLi);
|
|
517
|
+
const refreshHintLi = document.createElement('li');
|
|
518
|
+
refreshHintLi.innerText = 'Please refresh the page to try again.';
|
|
519
|
+
ul.appendChild(refreshHintLi);
|
|
520
|
+
const autoRefreshHintLi = document.createElement('li');
|
|
521
|
+
autoRefreshHintLi.innerText = 'The page will refresh automatically in 30 seconds.';
|
|
522
|
+
ul.appendChild(autoRefreshHintLi);
|
|
523
|
+
if (!hasUl) {
|
|
524
|
+
document.body.appendChild(ul);
|
|
525
|
+
}
|
|
526
|
+
setTimeout(() => location.reload(), 30000);
|
|
527
|
+
}
|
|
528
|
+
</code></pre>
|
|
529
|
+
</div>
|
|
530
|
+
</div>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
</div><div class="search-results">
|
|
540
|
+
<div class="has-results">
|
|
541
|
+
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
542
|
+
<ul class="search-results-list"></ul>
|
|
543
|
+
</div>
|
|
544
|
+
<div class="no-results">
|
|
545
|
+
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
546
|
+
</div>
|
|
547
|
+
</div>
|
|
548
|
+
</div>
|
|
549
|
+
<!-- END CONTENT -->
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
|
|
553
|
+
<label class="dark-mode-switch">
|
|
554
|
+
<input type="checkbox">
|
|
555
|
+
<span class="slider">
|
|
556
|
+
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
|
|
557
|
+
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
|
|
558
|
+
</svg>
|
|
559
|
+
</span>
|
|
560
|
+
</label>
|
|
561
|
+
|
|
562
|
+
<script>
|
|
563
|
+
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
|
|
564
|
+
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
|
|
565
|
+
var COMPODOC_CURRENT_PAGE_URL = 'ConfigLoadError.html';
|
|
566
|
+
var MAX_SEARCH_RESULTS = 15;
|
|
567
|
+
</script>
|
|
568
|
+
|
|
569
|
+
<script>
|
|
570
|
+
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
571
|
+
checkToggle(darkModeState);
|
|
572
|
+
if ($darkModeToggleSwitchers.length > 0) {
|
|
573
|
+
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
574
|
+
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
|
|
575
|
+
darkModeState = !darkModeState;
|
|
576
|
+
toggleDarkMode(darkModeState);
|
|
577
|
+
});
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
</script>
|
|
581
|
+
|
|
582
|
+
<script src="../js/libs/custom-elements.min.js"></script>
|
|
583
|
+
<script src="../js/libs/lit-html.js"></script>
|
|
584
|
+
|
|
585
|
+
<script src="../js/menu-wc.js" defer></script>
|
|
586
|
+
<script nomodule src="../js/menu-wc_es5.js" defer></script>
|
|
587
|
+
|
|
588
|
+
<script src="../js/libs/bootstrap-native.js"></script>
|
|
589
|
+
|
|
590
|
+
<script src="../js/libs/es6-shim.min.js"></script>
|
|
591
|
+
<script src="../js/libs/EventDispatcher.js"></script>
|
|
592
|
+
<script src="../js/libs/promise.min.js"></script>
|
|
593
|
+
<script src="../js/libs/zepto.min.js"></script>
|
|
594
|
+
|
|
595
|
+
<script src="../js/compodoc.js"></script>
|
|
596
|
+
|
|
597
|
+
<script src="../js/tabs.js"></script>
|
|
598
|
+
<script src="../js/menu.js"></script>
|
|
599
|
+
<script src="../js/libs/clipboard.min.js"></script>
|
|
600
|
+
<script src="../js/libs/prism.js"></script>
|
|
601
|
+
<script src="../js/sourceCode.js"></script>
|
|
602
|
+
<script src="../js/search/search.js"></script>
|
|
603
|
+
<script src="../js/search/lunr.min.js"></script>
|
|
604
|
+
<script src="../js/search/search-lunr.js"></script>
|
|
605
|
+
<script src="../js/search/search_index.js"></script>
|
|
606
|
+
<script src="../js/lazy-load-graphs.js"></script>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</body>
|
|
610
|
+
</html>
|