@connectreport/connectreport-js 2.80.3 → 2.81.0-beta.1
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/.openapi-generator/FILES +0 -1
- package/README.md +1 -1
- package/api.ts +220 -22
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/index.cjs +12 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +220 -24
- package/dist/index.d.ts +220 -24
- package/dist/index.js +11 -5
- package/dist/index.js.map +1 -1
- package/docs/assets/css/main.css +2679 -0
- package/docs/assets/images/icons.png +0 -0
- package/docs/assets/images/icons@2x.png +0 -0
- package/docs/assets/images/widgets.png +0 -0
- package/docs/assets/images/widgets@2x.png +0 -0
- package/docs/assets/js/main.js +1 -0
- package/docs/assets/js/search.json +1 -0
- package/docs/classes/_api_.basetemplatesapi.html +351 -0
- package/docs/classes/_api_.documentsapi.html +314 -0
- package/docs/classes/_api_.filtercyclesapi.html +483 -0
- package/docs/classes/_api_.imagesapi.html +354 -0
- package/docs/classes/_api_.jobsapi.html +311 -0
- package/docs/classes/_api_.reportsapi.html +400 -0
- package/docs/classes/_api_.reporttasksapi.html +503 -0
- package/docs/classes/_api_.templatesapi.html +676 -0
- package/docs/classes/_base_.baseapi.html +283 -0
- package/docs/classes/_base_.requirederror.html +291 -0
- package/docs/classes/_configuration_.configuration.html +345 -0
- package/docs/classes/_index_.connectreport.html +317 -0
- package/docs/enums/_api_.filtercycleemailenum.html +196 -0
- package/docs/enums/_api_.filtercyclefrequencyenum.html +238 -0
- package/docs/enums/_api_.reporttaskemailenum.html +196 -0
- package/docs/enums/_api_.reporttaskfrequencyenum.html +238 -0
- package/docs/enums/_api_.templateplatformenum.html +182 -0
- package/docs/globals.html +132 -0
- package/docs/index.html +145 -0
- package/docs/interfaces/_api_.filtercycle.html +791 -0
- package/docs/interfaces/_api_.filtercycleallof.html +273 -0
- package/docs/interfaces/_api_.filtercyclealloffieldinfo.html +228 -0
- package/docs/interfaces/_api_.filtercyclealloffieldvalues.html +228 -0
- package/docs/interfaces/_api_.inlineresponse200.html +186 -0
- package/docs/interfaces/_api_.inlineresponse2001.html +207 -0
- package/docs/interfaces/_api_.job.html +270 -0
- package/docs/interfaces/_api_.modelerror.html +207 -0
- package/docs/interfaces/_api_.report.html +348 -0
- package/docs/interfaces/_api_.reporttask.html +683 -0
- package/docs/interfaces/_api_.reporttaskcustomselection.html +234 -0
- package/docs/interfaces/_api_.reporttaskfieldvalues.html +207 -0
- package/docs/interfaces/_api_.reporttaskfiltersets.html +207 -0
- package/docs/interfaces/_api_.reporttaskgroupstosharewith.html +186 -0
- package/docs/interfaces/_api_.reporttasktags.html +207 -0
- package/docs/interfaces/_api_.reporttaskuserstosharewith.html +186 -0
- package/docs/interfaces/_api_.reporttaskvariables.html +207 -0
- package/docs/interfaces/_api_.template.html +291 -0
- package/docs/interfaces/_base_.requestargs.html +205 -0
- package/docs/interfaces/_configuration_.configurationparameters.html +253 -0
- package/docs/modules/_api_.html +4377 -0
- package/docs/modules/_base_.html +238 -0
- package/docs/modules/_configuration_.html +144 -0
- package/docs/modules/_index_.html +135 -0
- package/package.json +1 -1
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>BaseAPI | @connectreport/connectreport-js</title>
|
|
7
|
+
<meta name="description" content="Documentation for @connectreport/connectreport-js">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
</head>
|
|
11
|
+
<body>
|
|
12
|
+
<header>
|
|
13
|
+
<div class="tsd-page-toolbar">
|
|
14
|
+
<div class="container">
|
|
15
|
+
<div class="table-wrap">
|
|
16
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
+
<div class="field">
|
|
18
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
+
<input id="tsd-search-field" type="text" />
|
|
20
|
+
</div>
|
|
21
|
+
<ul class="results">
|
|
22
|
+
<li class="state loading">Preparing search index...</li>
|
|
23
|
+
<li class="state failure">The search index is not available</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<a href="../index.html" class="title">@connectreport/connectreport-js</a>
|
|
26
|
+
</div>
|
|
27
|
+
<div class="table-cell" id="tsd-widgets">
|
|
28
|
+
<div id="tsd-filter">
|
|
29
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
+
<div class="tsd-filter-group">
|
|
31
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
+
<span class="tsd-select-label">All</span>
|
|
33
|
+
<ul class="tsd-select-list">
|
|
34
|
+
<li data-value="public">Public</li>
|
|
35
|
+
<li data-value="protected">Public/Protected</li>
|
|
36
|
+
<li data-value="private" class="selected">All</li>
|
|
37
|
+
</ul>
|
|
38
|
+
</div>
|
|
39
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
+
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
</div>
|
|
52
|
+
<div class="tsd-page-title">
|
|
53
|
+
<div class="container">
|
|
54
|
+
<ul class="tsd-breadcrumb">
|
|
55
|
+
<li>
|
|
56
|
+
<a href="../globals.html">Globals</a>
|
|
57
|
+
</li>
|
|
58
|
+
<li>
|
|
59
|
+
<a href="../modules/_base_.html">"base"</a>
|
|
60
|
+
</li>
|
|
61
|
+
<li>
|
|
62
|
+
<a href="_base_.baseapi.html">BaseAPI</a>
|
|
63
|
+
</li>
|
|
64
|
+
</ul>
|
|
65
|
+
<h1>Class BaseAPI</h1>
|
|
66
|
+
</div>
|
|
67
|
+
</div>
|
|
68
|
+
</header>
|
|
69
|
+
<div class="container container-main">
|
|
70
|
+
<div class="row">
|
|
71
|
+
<div class="col-8 col-content">
|
|
72
|
+
<section class="tsd-panel tsd-comment">
|
|
73
|
+
<div class="tsd-comment tsd-typography">
|
|
74
|
+
<dl class="tsd-comment-tags">
|
|
75
|
+
<dt>export</dt>
|
|
76
|
+
<dd></dd>
|
|
77
|
+
</dl>
|
|
78
|
+
</div>
|
|
79
|
+
</section>
|
|
80
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
81
|
+
<h3>Hierarchy</h3>
|
|
82
|
+
<ul class="tsd-hierarchy">
|
|
83
|
+
<li>
|
|
84
|
+
<span class="target">BaseAPI</span>
|
|
85
|
+
<ul class="tsd-hierarchy">
|
|
86
|
+
<li>
|
|
87
|
+
<a href="_api_.basetemplatesapi.html" class="tsd-signature-type">BaseTemplatesApi</a>
|
|
88
|
+
</li>
|
|
89
|
+
<li>
|
|
90
|
+
<a href="_api_.documentsapi.html" class="tsd-signature-type">DocumentsApi</a>
|
|
91
|
+
</li>
|
|
92
|
+
<li>
|
|
93
|
+
<a href="_api_.filtercyclesapi.html" class="tsd-signature-type">FilterCyclesApi</a>
|
|
94
|
+
</li>
|
|
95
|
+
<li>
|
|
96
|
+
<a href="_api_.imagesapi.html" class="tsd-signature-type">ImagesApi</a>
|
|
97
|
+
</li>
|
|
98
|
+
<li>
|
|
99
|
+
<a href="_api_.jobsapi.html" class="tsd-signature-type">JobsApi</a>
|
|
100
|
+
</li>
|
|
101
|
+
<li>
|
|
102
|
+
<a href="_api_.reporttasksapi.html" class="tsd-signature-type">ReportTasksApi</a>
|
|
103
|
+
</li>
|
|
104
|
+
<li>
|
|
105
|
+
<a href="_api_.reportsapi.html" class="tsd-signature-type">ReportsApi</a>
|
|
106
|
+
</li>
|
|
107
|
+
<li>
|
|
108
|
+
<a href="_api_.templatesapi.html" class="tsd-signature-type">TemplatesApi</a>
|
|
109
|
+
</li>
|
|
110
|
+
</ul>
|
|
111
|
+
</li>
|
|
112
|
+
</ul>
|
|
113
|
+
</section>
|
|
114
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
115
|
+
<h2>Index</h2>
|
|
116
|
+
<section class="tsd-panel tsd-index-panel">
|
|
117
|
+
<div class="tsd-index-content">
|
|
118
|
+
<section class="tsd-index-section tsd-is-external">
|
|
119
|
+
<h3>Constructors</h3>
|
|
120
|
+
<ul class="tsd-index-list">
|
|
121
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_base_.baseapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
122
|
+
</ul>
|
|
123
|
+
</section>
|
|
124
|
+
<section class="tsd-index-section tsd-is-private-protected tsd-is-external">
|
|
125
|
+
<h3>Properties</h3>
|
|
126
|
+
<ul class="tsd-index-list">
|
|
127
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="_base_.baseapi.html#axios" class="tsd-kind-icon">axios</a></li>
|
|
128
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="_base_.baseapi.html#basepath" class="tsd-kind-icon">base<wbr>Path</a></li>
|
|
129
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="_base_.baseapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
|
130
|
+
</ul>
|
|
131
|
+
</section>
|
|
132
|
+
</div>
|
|
133
|
+
</section>
|
|
134
|
+
</section>
|
|
135
|
+
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
136
|
+
<h2>Constructors</h2>
|
|
137
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
138
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
139
|
+
<h3>constructor</h3>
|
|
140
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
141
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>BaseAPI<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, axios<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_base_.baseapi.html" class="tsd-signature-type">BaseAPI</a></li>
|
|
142
|
+
</ul>
|
|
143
|
+
<ul class="tsd-descriptions">
|
|
144
|
+
<li class="tsd-description">
|
|
145
|
+
<aside class="tsd-sources">
|
|
146
|
+
<ul>
|
|
147
|
+
<li>Defined in base.ts:50</li>
|
|
148
|
+
</ul>
|
|
149
|
+
</aside>
|
|
150
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
151
|
+
<ul class="tsd-parameters">
|
|
152
|
+
<li>
|
|
153
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> configuration: <a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a></h5>
|
|
154
|
+
</li>
|
|
155
|
+
<li>
|
|
156
|
+
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> basePath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></h5>
|
|
157
|
+
</li>
|
|
158
|
+
<li>
|
|
159
|
+
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> axios: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></h5>
|
|
160
|
+
</li>
|
|
161
|
+
</ul>
|
|
162
|
+
<h4 class="tsd-returns-title">Returns <a href="_base_.baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
|
163
|
+
</li>
|
|
164
|
+
</ul>
|
|
165
|
+
</section>
|
|
166
|
+
</section>
|
|
167
|
+
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected tsd-is-external">
|
|
168
|
+
<h2>Properties</h2>
|
|
169
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
170
|
+
<a name="axios" class="tsd-anchor"></a>
|
|
171
|
+
<h3><span class="tsd-flag ts-flagProtected">Protected</span> axios</h3>
|
|
172
|
+
<div class="tsd-signature tsd-kind-icon">axios<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div>
|
|
173
|
+
<aside class="tsd-sources">
|
|
174
|
+
<ul>
|
|
175
|
+
<li>Defined in base.ts:52</li>
|
|
176
|
+
</ul>
|
|
177
|
+
</aside>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
180
|
+
<a name="basepath" class="tsd-anchor"></a>
|
|
181
|
+
<h3><span class="tsd-flag ts-flagProtected">Protected</span> base<wbr>Path</h3>
|
|
182
|
+
<div class="tsd-signature tsd-kind-icon">base<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
183
|
+
<aside class="tsd-sources">
|
|
184
|
+
<ul>
|
|
185
|
+
<li>Defined in base.ts:52</li>
|
|
186
|
+
</ul>
|
|
187
|
+
</aside>
|
|
188
|
+
</section>
|
|
189
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
190
|
+
<a name="configuration" class="tsd-anchor"></a>
|
|
191
|
+
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
|
192
|
+
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
|
193
|
+
<aside class="tsd-sources">
|
|
194
|
+
<ul>
|
|
195
|
+
<li>Defined in base.ts:50</li>
|
|
196
|
+
</ul>
|
|
197
|
+
</aside>
|
|
198
|
+
</section>
|
|
199
|
+
</section>
|
|
200
|
+
</div>
|
|
201
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
202
|
+
<nav class="tsd-navigation primary">
|
|
203
|
+
<ul>
|
|
204
|
+
<li class="globals ">
|
|
205
|
+
<a href="../globals.html"><em>Globals</em></a>
|
|
206
|
+
</li>
|
|
207
|
+
<li class="label tsd-is-external">
|
|
208
|
+
<span>Internals</span>
|
|
209
|
+
</li>
|
|
210
|
+
<li class=" tsd-kind-module">
|
|
211
|
+
<a href="../modules/_index_.html">"index"</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class="label tsd-is-external">
|
|
214
|
+
<span>Externals</span>
|
|
215
|
+
</li>
|
|
216
|
+
<li class=" tsd-kind-module tsd-is-external">
|
|
217
|
+
<a href="../modules/_api_.html">"api"</a>
|
|
218
|
+
</li>
|
|
219
|
+
<li class="current tsd-kind-module tsd-is-external">
|
|
220
|
+
<a href="../modules/_base_.html">"base"</a>
|
|
221
|
+
</li>
|
|
222
|
+
<li class=" tsd-kind-module tsd-is-external">
|
|
223
|
+
<a href="../modules/_configuration_.html">"configuration"</a>
|
|
224
|
+
</li>
|
|
225
|
+
</ul>
|
|
226
|
+
</nav>
|
|
227
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
228
|
+
<ul class="before-current">
|
|
229
|
+
</ul>
|
|
230
|
+
<ul class="current">
|
|
231
|
+
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
232
|
+
<a href="_base_.baseapi.html" class="tsd-kind-icon">BaseAPI</a>
|
|
233
|
+
<ul>
|
|
234
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
235
|
+
<a href="_base_.baseapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
236
|
+
</li>
|
|
237
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
238
|
+
<a href="_base_.baseapi.html#axios" class="tsd-kind-icon">axios</a>
|
|
239
|
+
</li>
|
|
240
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
241
|
+
<a href="_base_.baseapi.html#basepath" class="tsd-kind-icon">base<wbr>Path</a>
|
|
242
|
+
</li>
|
|
243
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
|
|
244
|
+
<a href="_base_.baseapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
|
245
|
+
</li>
|
|
246
|
+
</ul>
|
|
247
|
+
</li>
|
|
248
|
+
</ul>
|
|
249
|
+
<ul class="after-current">
|
|
250
|
+
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
251
|
+
<a href="_base_.requirederror.html" class="tsd-kind-icon">Required<wbr>Error</a>
|
|
252
|
+
</li>
|
|
253
|
+
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
|
|
254
|
+
<a href="../interfaces/_base_.requestargs.html" class="tsd-kind-icon">Request<wbr>Args</a>
|
|
255
|
+
</li>
|
|
256
|
+
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external">
|
|
257
|
+
<a href="../modules/_base_.html#base_path" class="tsd-kind-icon">BASE_<wbr>PATH</a>
|
|
258
|
+
</li>
|
|
259
|
+
<li class=" tsd-kind-object-literal tsd-parent-kind-module tsd-is-external">
|
|
260
|
+
<a href="../modules/_base_.html#collection_formats" class="tsd-kind-icon">COLLECTION_<wbr>FORMATS</a>
|
|
261
|
+
</li>
|
|
262
|
+
</ul>
|
|
263
|
+
</nav>
|
|
264
|
+
</div>
|
|
265
|
+
</div>
|
|
266
|
+
</div>
|
|
267
|
+
<footer class="with-border-bottom">
|
|
268
|
+
<div class="container">
|
|
269
|
+
<h2>Legend</h2>
|
|
270
|
+
<div class="tsd-legend-group">
|
|
271
|
+
<ul class="tsd-legend">
|
|
272
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
273
|
+
</ul>
|
|
274
|
+
</div>
|
|
275
|
+
</div>
|
|
276
|
+
</footer>
|
|
277
|
+
<div class="container tsd-generator">
|
|
278
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
279
|
+
</div>
|
|
280
|
+
<div class="overlay"></div>
|
|
281
|
+
<script src="../assets/js/main.js"></script>
|
|
282
|
+
</body>
|
|
283
|
+
</html>
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>RequiredError | @connectreport/connectreport-js</title>
|
|
7
|
+
<meta name="description" content="Documentation for @connectreport/connectreport-js">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
</head>
|
|
11
|
+
<body>
|
|
12
|
+
<header>
|
|
13
|
+
<div class="tsd-page-toolbar">
|
|
14
|
+
<div class="container">
|
|
15
|
+
<div class="table-wrap">
|
|
16
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
17
|
+
<div class="field">
|
|
18
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
+
<input id="tsd-search-field" type="text" />
|
|
20
|
+
</div>
|
|
21
|
+
<ul class="results">
|
|
22
|
+
<li class="state loading">Preparing search index...</li>
|
|
23
|
+
<li class="state failure">The search index is not available</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<a href="../index.html" class="title">@connectreport/connectreport-js</a>
|
|
26
|
+
</div>
|
|
27
|
+
<div class="table-cell" id="tsd-widgets">
|
|
28
|
+
<div id="tsd-filter">
|
|
29
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
+
<div class="tsd-filter-group">
|
|
31
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
+
<span class="tsd-select-label">All</span>
|
|
33
|
+
<ul class="tsd-select-list">
|
|
34
|
+
<li data-value="public">Public</li>
|
|
35
|
+
<li data-value="protected">Public/Protected</li>
|
|
36
|
+
<li data-value="private" class="selected">All</li>
|
|
37
|
+
</ul>
|
|
38
|
+
</div>
|
|
39
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
+
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
</div>
|
|
52
|
+
<div class="tsd-page-title">
|
|
53
|
+
<div class="container">
|
|
54
|
+
<ul class="tsd-breadcrumb">
|
|
55
|
+
<li>
|
|
56
|
+
<a href="../globals.html">Globals</a>
|
|
57
|
+
</li>
|
|
58
|
+
<li>
|
|
59
|
+
<a href="../modules/_base_.html">"base"</a>
|
|
60
|
+
</li>
|
|
61
|
+
<li>
|
|
62
|
+
<a href="_base_.requirederror.html">RequiredError</a>
|
|
63
|
+
</li>
|
|
64
|
+
</ul>
|
|
65
|
+
<h1>Class RequiredError</h1>
|
|
66
|
+
</div>
|
|
67
|
+
</div>
|
|
68
|
+
</header>
|
|
69
|
+
<div class="container container-main">
|
|
70
|
+
<div class="row">
|
|
71
|
+
<div class="col-8 col-content">
|
|
72
|
+
<section class="tsd-panel tsd-comment">
|
|
73
|
+
<div class="tsd-comment tsd-typography">
|
|
74
|
+
<dl class="tsd-comment-tags">
|
|
75
|
+
<dt>export</dt>
|
|
76
|
+
<dd></dd>
|
|
77
|
+
</dl>
|
|
78
|
+
</div>
|
|
79
|
+
</section>
|
|
80
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
81
|
+
<h3>Hierarchy</h3>
|
|
82
|
+
<ul class="tsd-hierarchy">
|
|
83
|
+
<li>
|
|
84
|
+
<a href="_base_.requirederror.html#error" class="tsd-signature-type">Error</a>
|
|
85
|
+
<ul class="tsd-hierarchy">
|
|
86
|
+
<li>
|
|
87
|
+
<span class="target">RequiredError</span>
|
|
88
|
+
</li>
|
|
89
|
+
</ul>
|
|
90
|
+
</li>
|
|
91
|
+
</ul>
|
|
92
|
+
</section>
|
|
93
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
94
|
+
<h2>Index</h2>
|
|
95
|
+
<section class="tsd-panel tsd-index-panel">
|
|
96
|
+
<div class="tsd-index-content">
|
|
97
|
+
<section class="tsd-index-section tsd-is-external">
|
|
98
|
+
<h3>Constructors</h3>
|
|
99
|
+
<ul class="tsd-index-list">
|
|
100
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_base_.requirederror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
101
|
+
</ul>
|
|
102
|
+
</section>
|
|
103
|
+
<section class="tsd-index-section tsd-is-external">
|
|
104
|
+
<h3>Properties</h3>
|
|
105
|
+
<ul class="tsd-index-list">
|
|
106
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_base_.requirederror.html#field" class="tsd-kind-icon">field</a></li>
|
|
107
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_base_.requirederror.html#message" class="tsd-kind-icon">message</a></li>
|
|
108
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_base_.requirederror.html#name" class="tsd-kind-icon">name</a></li>
|
|
109
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="_base_.requirederror.html#stack" class="tsd-kind-icon">stack</a></li>
|
|
110
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_base_.requirederror.html#error" class="tsd-kind-icon">Error</a></li>
|
|
111
|
+
</ul>
|
|
112
|
+
</section>
|
|
113
|
+
</div>
|
|
114
|
+
</section>
|
|
115
|
+
</section>
|
|
116
|
+
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
117
|
+
<h2>Constructors</h2>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
119
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
120
|
+
<h3>constructor</h3>
|
|
121
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
122
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>Required<wbr>Error<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, msg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_base_.requirederror.html" class="tsd-signature-type">RequiredError</a></li>
|
|
123
|
+
</ul>
|
|
124
|
+
<ul class="tsd-descriptions">
|
|
125
|
+
<li class="tsd-description">
|
|
126
|
+
<aside class="tsd-sources">
|
|
127
|
+
<ul>
|
|
128
|
+
<li>Defined in base.ts:67</li>
|
|
129
|
+
</ul>
|
|
130
|
+
</aside>
|
|
131
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
132
|
+
<ul class="tsd-parameters">
|
|
133
|
+
<li>
|
|
134
|
+
<h5>field: <span class="tsd-signature-type">string</span></h5>
|
|
135
|
+
</li>
|
|
136
|
+
<li>
|
|
137
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> msg: <span class="tsd-signature-type">string</span></h5>
|
|
138
|
+
</li>
|
|
139
|
+
</ul>
|
|
140
|
+
<h4 class="tsd-returns-title">Returns <a href="_base_.requirederror.html" class="tsd-signature-type">RequiredError</a></h4>
|
|
141
|
+
</li>
|
|
142
|
+
</ul>
|
|
143
|
+
</section>
|
|
144
|
+
</section>
|
|
145
|
+
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
146
|
+
<h2>Properties</h2>
|
|
147
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
148
|
+
<a name="field" class="tsd-anchor"></a>
|
|
149
|
+
<h3>field</h3>
|
|
150
|
+
<div class="tsd-signature tsd-kind-icon">field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
151
|
+
<aside class="tsd-sources">
|
|
152
|
+
<ul>
|
|
153
|
+
<li>Defined in base.ts:68</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</aside>
|
|
156
|
+
</section>
|
|
157
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
158
|
+
<a name="message" class="tsd-anchor"></a>
|
|
159
|
+
<h3>message</h3>
|
|
160
|
+
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
161
|
+
<aside class="tsd-sources">
|
|
162
|
+
<p>Inherited from <a href="_base_.requirederror.html">RequiredError</a>.<a href="_base_.requirederror.html#message">message</a></p>
|
|
163
|
+
<ul>
|
|
164
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li>
|
|
165
|
+
</ul>
|
|
166
|
+
</aside>
|
|
167
|
+
</section>
|
|
168
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
|
|
169
|
+
<a name="name" class="tsd-anchor"></a>
|
|
170
|
+
<h3>name</h3>
|
|
171
|
+
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"RequiredError"</span><span class="tsd-signature-symbol"> = "RequiredError"</span></div>
|
|
172
|
+
<aside class="tsd-sources">
|
|
173
|
+
<p>Overrides Error.name</p>
|
|
174
|
+
<ul>
|
|
175
|
+
<li>Defined in base.ts:67</li>
|
|
176
|
+
</ul>
|
|
177
|
+
</aside>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external">
|
|
180
|
+
<a name="stack" class="tsd-anchor"></a>
|
|
181
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
|
182
|
+
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
183
|
+
<aside class="tsd-sources">
|
|
184
|
+
<p>Inherited from <a href="_base_.requirederror.html">RequiredError</a>.<a href="_base_.requirederror.html#stack">stack</a></p>
|
|
185
|
+
<p>Overrides <a href="_base_.requirederror.html">RequiredError</a>.<a href="_base_.requirederror.html#stack">stack</a></p>
|
|
186
|
+
<ul>
|
|
187
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
|
|
188
|
+
</ul>
|
|
189
|
+
</aside>
|
|
190
|
+
</section>
|
|
191
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
192
|
+
<a name="error" class="tsd-anchor"></a>
|
|
193
|
+
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
|
194
|
+
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
|
195
|
+
<aside class="tsd-sources">
|
|
196
|
+
<ul>
|
|
197
|
+
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:984</li>
|
|
198
|
+
</ul>
|
|
199
|
+
</aside>
|
|
200
|
+
</section>
|
|
201
|
+
</section>
|
|
202
|
+
</div>
|
|
203
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
204
|
+
<nav class="tsd-navigation primary">
|
|
205
|
+
<ul>
|
|
206
|
+
<li class="globals ">
|
|
207
|
+
<a href="../globals.html"><em>Globals</em></a>
|
|
208
|
+
</li>
|
|
209
|
+
<li class="label tsd-is-external">
|
|
210
|
+
<span>Internals</span>
|
|
211
|
+
</li>
|
|
212
|
+
<li class=" tsd-kind-module">
|
|
213
|
+
<a href="../modules/_index_.html">"index"</a>
|
|
214
|
+
</li>
|
|
215
|
+
<li class="label tsd-is-external">
|
|
216
|
+
<span>Externals</span>
|
|
217
|
+
</li>
|
|
218
|
+
<li class=" tsd-kind-module tsd-is-external">
|
|
219
|
+
<a href="../modules/_api_.html">"api"</a>
|
|
220
|
+
</li>
|
|
221
|
+
<li class="current tsd-kind-module tsd-is-external">
|
|
222
|
+
<a href="../modules/_base_.html">"base"</a>
|
|
223
|
+
</li>
|
|
224
|
+
<li class=" tsd-kind-module tsd-is-external">
|
|
225
|
+
<a href="../modules/_configuration_.html">"configuration"</a>
|
|
226
|
+
</li>
|
|
227
|
+
</ul>
|
|
228
|
+
</nav>
|
|
229
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
230
|
+
<ul class="before-current">
|
|
231
|
+
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
232
|
+
<a href="_base_.baseapi.html" class="tsd-kind-icon">BaseAPI</a>
|
|
233
|
+
</li>
|
|
234
|
+
</ul>
|
|
235
|
+
<ul class="current">
|
|
236
|
+
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
237
|
+
<a href="_base_.requirederror.html" class="tsd-kind-icon">Required<wbr>Error</a>
|
|
238
|
+
<ul>
|
|
239
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
|
240
|
+
<a href="_base_.requirederror.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
241
|
+
</li>
|
|
242
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
243
|
+
<a href="_base_.requirederror.html#field" class="tsd-kind-icon">field</a>
|
|
244
|
+
</li>
|
|
245
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
246
|
+
<a href="_base_.requirederror.html#message" class="tsd-kind-icon">message</a>
|
|
247
|
+
</li>
|
|
248
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
|
|
249
|
+
<a href="_base_.requirederror.html#name" class="tsd-kind-icon">name</a>
|
|
250
|
+
</li>
|
|
251
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external">
|
|
252
|
+
<a href="_base_.requirederror.html#stack" class="tsd-kind-icon">stack</a>
|
|
253
|
+
</li>
|
|
254
|
+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
|
|
255
|
+
<a href="_base_.requirederror.html#error" class="tsd-kind-icon">Error</a>
|
|
256
|
+
</li>
|
|
257
|
+
</ul>
|
|
258
|
+
</li>
|
|
259
|
+
</ul>
|
|
260
|
+
<ul class="after-current">
|
|
261
|
+
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
|
|
262
|
+
<a href="../interfaces/_base_.requestargs.html" class="tsd-kind-icon">Request<wbr>Args</a>
|
|
263
|
+
</li>
|
|
264
|
+
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external">
|
|
265
|
+
<a href="../modules/_base_.html#base_path" class="tsd-kind-icon">BASE_<wbr>PATH</a>
|
|
266
|
+
</li>
|
|
267
|
+
<li class=" tsd-kind-object-literal tsd-parent-kind-module tsd-is-external">
|
|
268
|
+
<a href="../modules/_base_.html#collection_formats" class="tsd-kind-icon">COLLECTION_<wbr>FORMATS</a>
|
|
269
|
+
</li>
|
|
270
|
+
</ul>
|
|
271
|
+
</nav>
|
|
272
|
+
</div>
|
|
273
|
+
</div>
|
|
274
|
+
</div>
|
|
275
|
+
<footer class="with-border-bottom">
|
|
276
|
+
<div class="container">
|
|
277
|
+
<h2>Legend</h2>
|
|
278
|
+
<div class="tsd-legend-group">
|
|
279
|
+
<ul class="tsd-legend">
|
|
280
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
281
|
+
</ul>
|
|
282
|
+
</div>
|
|
283
|
+
</div>
|
|
284
|
+
</footer>
|
|
285
|
+
<div class="container tsd-generator">
|
|
286
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
287
|
+
</div>
|
|
288
|
+
<div class="overlay"></div>
|
|
289
|
+
<script src="../assets/js/main.js"></script>
|
|
290
|
+
</body>
|
|
291
|
+
</html>
|