@breautek/storm 9.8.0 → 9.8.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/CHANGELOG.md +7 -0
- package/docs/classes/Application.html +54 -54
- package/docs/classes/ConfigLoader.html +4 -4
- package/docs/classes/Database.html +13 -13
- package/docs/classes/DatabaseCastObject.html +4 -4
- package/docs/classes/DatabaseConnection.html +25 -25
- package/docs/classes/DatabaseQueryError.html +15 -15
- package/docs/classes/DeadLockError.html +15 -15
- package/docs/classes/DiskSpaceError.html +14 -14
- package/docs/classes/DropTemporaryTableQuery.html +10 -10
- package/docs/classes/DuplicateEntryError.html +14 -14
- package/docs/classes/EntityNotFoundError.html +14 -14
- package/docs/classes/ExpiredTokenError.html +14 -14
- package/docs/classes/ForbiddenError.html +14 -14
- package/docs/classes/GetMySQLVersion.html +10 -10
- package/docs/classes/Handler.html +16 -16
- package/docs/classes/IllegalStateError.html +14 -14
- package/docs/classes/InternalError.html +14 -14
- package/docs/classes/InvalidCredentialsError.html +14 -14
- package/docs/classes/InvalidValueError.html +14 -14
- package/docs/classes/LineString.html +5 -5
- package/docs/classes/LockWaitTimeoutError.html +15 -15
- package/docs/classes/ManagedDatabaseConnection.html +25 -25
- package/docs/classes/MetricStore.html +7 -7
- package/docs/classes/Middleware.html +5 -5
- package/docs/classes/MissingConfigError.html +14 -14
- package/docs/classes/MissingParameterError.html +14 -14
- package/docs/classes/MySQLConnection.html +28 -28
- package/docs/classes/MySQLDatabase.html +14 -14
- package/docs/classes/NotImplementedError.html +14 -14
- package/docs/classes/Point.html +5 -5
- package/docs/classes/Polygon.html +5 -5
- package/docs/classes/Query.html +10 -10
- package/docs/classes/RawError.html +14 -14
- package/docs/classes/RawQuery.html +10 -10
- package/docs/classes/Request.html +26 -26
- package/docs/classes/Response.html +12 -12
- package/docs/classes/ResponseData.html +9 -9
- package/docs/classes/ServiceProvider.html +16 -16
- package/docs/classes/ServiceResponse.html +6 -6
- package/docs/classes/SetSessionVariableQuery.html +10 -10
- package/docs/classes/StormError.html +14 -14
- package/docs/classes/TemporaryTableQuery.html +10 -10
- package/docs/classes/TimeoutError.html +14 -14
- package/docs/classes/Token.html +3 -3
- package/docs/classes/TokenManager.html +6 -6
- package/docs/classes/Transaction.html +8 -8
- package/docs/classes/UnauthorizedAccessError.html +14 -14
- package/docs/enums/ErrorCode.html +10 -10
- package/docs/enums/ExitCode.html +3 -3
- package/docs/enums/HTTPMethod.html +5 -5
- package/docs/enums/IsolationLevel.html +5 -5
- package/docs/enums/JWTError.html +3 -3
- package/docs/enums/StatusCode.html +49 -49
- package/docs/enums/TransactionAccessLevel.html +3 -3
- package/docs/functions/getInstance.html +1 -1
- package/docs/interfaces/IAdditionalErrorDetails.html +1 -1
- package/docs/interfaces/ICloudwatchConfig.html +4 -4
- package/docs/interfaces/ICloudwatchCredentials.html +3 -3
- package/docs/interfaces/ICloudwatchStreamConfig.html +3 -3
- package/docs/interfaces/IConfig.html +13 -13
- package/docs/interfaces/IDatabaseConfig.html +7 -7
- package/docs/interfaces/IDatabaseConnection.html +20 -20
- package/docs/interfaces/IDatabasePosition.html +3 -3
- package/docs/interfaces/IErrorResponse.html +6 -6
- package/docs/interfaces/IFormData.html +3 -3
- package/docs/interfaces/IGetMySQLVersionResult.html +5 -5
- package/docs/interfaces/IGetMySQLVersionRow.html +2 -2
- package/docs/interfaces/IHistogramConfig.html +5 -5
- package/docs/interfaces/IInsertQueryResult.html +4 -4
- package/docs/interfaces/IJWTVerifyOptions.html +2 -2
- package/docs/interfaces/IMetricConfig.html +4 -4
- package/docs/interfaces/IMetricCounter.html +3 -3
- package/docs/interfaces/IMetricGauge.html +7 -7
- package/docs/interfaces/IMetricHistogram.html +4 -4
- package/docs/interfaces/IOKPacket.html +9 -9
- package/docs/interfaces/IParameterMap.html +1 -1
- package/docs/interfaces/IQueryable.html +7 -7
- package/docs/interfaces/IRequestResponse.html +3 -3
- package/docs/interfaces/ISetSessionVariableQueryInput.html +3 -3
- package/docs/interfaces/IStormCLIArgs.html +8 -8
- package/docs/interfaces/ITemporaryTableQueryInput.html +3 -3
- package/docs/interfaces/IUpdateQueryResult.html +3 -3
- package/docs/interfaces/formidable.Part.html +17 -17
- package/docs/types/IDeleteQueryResult.html +1 -1
- package/docs/types/IStoredProcedureResult.html +1 -1
- package/docs/types/TCoordinate.html +1 -1
- package/docs/types/TExpiresIn.html +1 -1
- package/docs/types/TSerializableResponse.html +1 -1
- package/docs/types/TSupportedResponsePrimitives.html +1 -1
- package/docs/types/TSupportedResponseTypes.html +1 -1
- package/lib/Response.js +12 -1
- package/lib/Response.js.map +1 -1
- package/package.json +6 -6
- package/pnpm-workspace.yaml +1 -0
- package/src/Response.ts +14 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,8 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d
|
|
|
4
4
|
|
|
5
5
|
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
6
6
|
|
|
7
|
+
#### [v9.8.1](https://github.com/breautek/storm/compare/v9.8.0...v9.8.1)
|
|
8
|
+
|
|
9
|
+
- deproll [`5755f1e`](https://github.com/breautek/storm/commit/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa)
|
|
10
|
+
- propagate socket errors when using stream responses [`fa831c6`](https://github.com/breautek/storm/commit/fa831c6d28f68f25a2a9b9954615c80082541d3d)
|
|
11
|
+
|
|
7
12
|
#### [v9.8.0](https://github.com/breautek/storm/compare/v9.7.5...v9.8.0)
|
|
8
13
|
|
|
14
|
+
> 25 August 2026
|
|
15
|
+
|
|
9
16
|
- deproll [`454a5ce`](https://github.com/breautek/storm/commit/454a5ce1675cfb629a9d09359d019a21224c5f20)
|
|
10
17
|
- deproll [`40da12a`](https://github.com/breautek/storm/commit/40da12a6ba8065972cb04df57a2688240b74f4b3)
|
|
11
18
|
- Support handler bridge and raw handler support for handling requests pre routing middlewares. [`59bf0b2`](https://github.com/breautek/storm/commit/59bf0b251a3305d58f5e2077e5f293145ab14358)
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
<ul class="tsd-hierarchy">
|
|
28
28
|
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Application</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
29
29
|
<ul>
|
|
30
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
30
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L62">src/Application.ts:62</a></li></ul></aside>
|
|
31
31
|
<section class="tsd-panel-group tsd-index-group">
|
|
32
32
|
<section class="tsd-panel tsd-index-panel">
|
|
33
33
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
</div></div><aside class="tsd-sources">
|
|
123
123
|
<p>Overrides EventEmitter.constructor</p>
|
|
124
124
|
<ul>
|
|
125
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
125
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L106">src/Application.ts:106</a></li></ul></aside></div></li></ul></section></section></details>
|
|
126
126
|
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
127
127
|
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
128
128
|
<section>
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise<void></p>
|
|
142
142
|
<aside class="tsd-sources">
|
|
143
143
|
<ul>
|
|
144
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
144
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L470">src/Application.ts:470</a></li></ul></aside></div></li></ul></section>
|
|
145
145
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
146
146
|
<h3 class="tsd-anchor-link" id="_attachrawhandlers"><code class="tsd-tag">Protected</code><span>_<wbr/>attach<wbr/>Raw<wbr/>Handlers</span><a href="#_attachrawhandlers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
147
147
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<li><span><span class="tsd-kind-parameter">attacher</span>: <span class="tsd-signature-type">IHandlerAttachBridge</span></span></li></ul></div>
|
|
155
155
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
156
156
|
<ul>
|
|
157
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
157
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L472">src/Application.ts:472</a></li></ul></aside></div></li></ul></section>
|
|
158
158
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
159
159
|
<h3 class="tsd-anchor-link" id="_buildargoptions"><code class="tsd-tag">Protected</code><span>_<wbr/>build<wbr/>Arg<wbr/>Options</span><a href="#_buildargoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
160
160
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -167,7 +167,7 @@
|
|
|
167
167
|
<li><span><span class="tsd-kind-parameter">program</span>: <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div>
|
|
168
168
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
169
169
|
<ul>
|
|
170
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
170
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L383">src/Application.ts:383</a></li></ul></aside></div></li></ul></section>
|
|
171
171
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
172
172
|
<h3 class="tsd-anchor-link" id="_closedatabase"><code class="tsd-tag">Protected</code><span>_<wbr/>close<wbr/>Database</span><a href="#_closedatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
173
173
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -176,7 +176,7 @@
|
|
|
176
176
|
<div class="tsd-description">
|
|
177
177
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
178
178
|
<ul>
|
|
179
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
179
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L447">src/Application.ts:447</a></li></ul></aside></div></li></ul></section>
|
|
180
180
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
181
181
|
<h3 class="tsd-anchor-link" id="_closesocket"><code class="tsd-tag">Protected</code><span>_<wbr/>close<wbr/>Socket</span><a href="#_closesocket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
182
182
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -185,7 +185,7 @@
|
|
|
185
185
|
<div class="tsd-description">
|
|
186
186
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
187
187
|
<ul>
|
|
188
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
188
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L453">src/Application.ts:453</a></li></ul></aside></div></li></ul></section>
|
|
189
189
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
190
190
|
<h3 class="tsd-anchor-link" id="_createlogger"><code class="tsd-tag">Protected</code><span>_<wbr/>create<wbr/>Logger</span><a href="#_createlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
191
191
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -198,7 +198,7 @@
|
|
|
198
198
|
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
199
199
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BaseLogger</span></h4><aside class="tsd-sources">
|
|
200
200
|
<ul>
|
|
201
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
201
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L258">src/Application.ts:258</a></li></ul></aside></div></li></ul></section>
|
|
202
202
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
203
203
|
<h3 class="tsd-anchor-link" id="_getversion"><code class="tsd-tag">Protected</code><span>_<wbr/>get<wbr/>Version</span><a href="#_getversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
204
204
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
<div class="tsd-description">
|
|
208
208
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
209
209
|
<ul>
|
|
210
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
210
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L346">src/Application.ts:346</a></li></ul></aside></div></li></ul></section>
|
|
211
211
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
212
212
|
<h3 class="tsd-anchor-link" id="_initdb"><code class="tsd-tag">Protected</code><span>_<wbr/>init<wbr/>DB</span><a href="#_initdb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
213
213
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -224,7 +224,7 @@
|
|
|
224
224
|
</div></li></ul></div>
|
|
225
225
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Database.html" class="tsd-signature-type tsd-kind-class">Database</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
226
226
|
<ul>
|
|
227
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
227
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L633">src/Application.ts:633</a></li></ul></aside></div></li></ul></section>
|
|
228
228
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
229
229
|
<h3 class="tsd-anchor-link" id="_initialize"><code class="tsd-tag">Protected</code><span>_<wbr/>initialize</span><a href="#_initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
230
230
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
238
238
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
239
239
|
<ul>
|
|
240
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
240
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L254">src/Application.ts:254</a></li></ul></aside></div></li></ul></section>
|
|
241
241
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
242
242
|
<h3 class="tsd-anchor-link" id="_initlogger"><code class="tsd-tag">Protected</code><span>_<wbr/>init<wbr/>Logger</span><a href="#_initlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
243
243
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -250,7 +250,7 @@
|
|
|
250
250
|
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
251
251
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BaseLogger</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
252
252
|
<ul>
|
|
253
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
253
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L262">src/Application.ts:262</a></li></ul></aside></div></li></ul></section>
|
|
254
254
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
255
255
|
<h3 class="tsd-anchor-link" id="_onbeforereadyasync"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Before<wbr/>Ready<wbr/>Async</span><a href="#_onbeforereadyasync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
256
256
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -259,7 +259,7 @@
|
|
|
259
259
|
<div class="tsd-description">
|
|
260
260
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
261
261
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
262
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L637">src/Application.ts:637</a></li></ul></aside></div></li></ul></section>
|
|
263
263
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
264
264
|
<h3 class="tsd-anchor-link" id="_onconfigload"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Config<wbr/>Load</span><a href="#_onconfigload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
265
265
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -276,7 +276,7 @@
|
|
|
276
276
|
</div></li></ul></div>
|
|
277
277
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
278
278
|
<ul>
|
|
279
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
279
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L566">src/Application.ts:566</a></li></ul></aside></div></li></ul></section>
|
|
280
280
|
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
281
281
|
<h3 class="tsd-anchor-link" id="_onready"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Ready</span><a href="#_onready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
282
282
|
<ul class="tsd-signatures tsd-is-protected">
|
|
@@ -287,7 +287,7 @@
|
|
|
287
287
|
</div>
|
|
288
288
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
289
289
|
<ul>
|
|
290
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
290
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L642">src/Application.ts:642</a></li></ul></aside></div></li></ul></section>
|
|
291
291
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
292
292
|
<h3 class="tsd-anchor-link" id="capturerejectionsymbol"><code class="tsd-tag">Optional</code><span>[capture<wbr/>Rejection<wbr/>Symbol]</span><a href="#capturerejectionsymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
293
293
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -316,7 +316,7 @@ place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
|
316
316
|
</div></div><aside class="tsd-sources">
|
|
317
317
|
<p>Inherited from EventEmitter.[captureRejectionSymbol]</p>
|
|
318
318
|
<ul>
|
|
319
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
319
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:87</li></ul></aside></div></li></ul></section>
|
|
320
320
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
321
321
|
<h3 class="tsd-anchor-link" id="addlistener"><span>add<wbr/>Listener</span><a href="#addlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
322
322
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -341,7 +341,7 @@ place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
|
341
341
|
</div></div><aside class="tsd-sources">
|
|
342
342
|
<p>Inherited from EventEmitter.addListener</p>
|
|
343
343
|
<ul>
|
|
344
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
344
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:92</li></ul></aside></div></li></ul></section>
|
|
345
345
|
<section class="tsd-panel tsd-member">
|
|
346
346
|
<h3 class="tsd-anchor-link" id="attachhandler"><span class="deprecated">attach<wbr/>Handler</span><a href="#attachhandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
347
347
|
<ul class="tsd-signatures">
|
|
@@ -363,7 +363,7 @@ place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
|
363
363
|
</ul>
|
|
364
364
|
</div></div><aside class="tsd-sources">
|
|
365
365
|
<ul>
|
|
366
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
366
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L412">src/Application.ts:412</a></li></ul></aside></div></li></ul></section>
|
|
367
367
|
<section class="tsd-panel tsd-member">
|
|
368
368
|
<h3 class="tsd-anchor-link" id="attachhandlerinstance"><span class="deprecated">attach<wbr/>Handler<wbr/>Instance</span><a href="#attachhandlerinstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
369
369
|
<ul class="tsd-signatures">
|
|
@@ -383,7 +383,7 @@ place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
|
383
383
|
</ul>
|
|
384
384
|
</div></div><aside class="tsd-sources">
|
|
385
385
|
<ul>
|
|
386
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
386
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L421">src/Application.ts:421</a></li></ul></aside></div></li></ul></section>
|
|
387
387
|
<section class="tsd-panel tsd-member">
|
|
388
388
|
<h3 class="tsd-anchor-link" id="close"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
389
389
|
<ul class="tsd-signatures">
|
|
@@ -392,7 +392,7 @@ place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
|
392
392
|
<div class="tsd-description">
|
|
393
393
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
394
394
|
<ul>
|
|
395
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
395
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L440">src/Application.ts:440</a></li></ul></aside></div></li></ul></section>
|
|
396
396
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
397
397
|
<h3 class="tsd-anchor-link" id="emit"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
398
398
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -423,7 +423,7 @@ to each.</p>
|
|
|
423
423
|
</div></div><aside class="tsd-sources">
|
|
424
424
|
<p>Inherited from EventEmitter.emit</p>
|
|
425
425
|
<ul>
|
|
426
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
426
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:134</li></ul></aside></div></li></ul></section>
|
|
427
427
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
428
428
|
<h3 class="tsd-anchor-link" id="eventnames"><span>event<wbr/>Names</span><a href="#eventnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
429
429
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -443,7 +443,7 @@ listeners.</p>
|
|
|
443
443
|
</div></div><aside class="tsd-sources">
|
|
444
444
|
<p>Inherited from EventEmitter.eventNames</p>
|
|
445
445
|
<ul>
|
|
446
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
446
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:154</li></ul></aside></div></li></ul></section>
|
|
447
447
|
<section class="tsd-panel tsd-member">
|
|
448
448
|
<h3 class="tsd-anchor-link" id="getcmdlineargs"><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span><a href="#getcmdlineargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
449
449
|
<ul class="tsd-signatures">
|
|
@@ -453,7 +453,7 @@ listeners.</p>
|
|
|
453
453
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/IStormCLIArgs.html" class="tsd-signature-type tsd-kind-interface">IStormCLIArgs</a></h4><p>command line arguments</p>
|
|
454
454
|
<aside class="tsd-sources">
|
|
455
455
|
<ul>
|
|
456
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
456
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L593">src/Application.ts:593</a></li></ul></aside></div></li></ul></section>
|
|
457
457
|
<section class="tsd-panel tsd-member">
|
|
458
458
|
<h3 class="tsd-anchor-link" id="getconfig"><span>get<wbr/>Config</span><a href="#getconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
459
459
|
<ul class="tsd-signatures">
|
|
@@ -463,7 +463,7 @@ listeners.</p>
|
|
|
463
463
|
<h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></h4><p>the config object.</p>
|
|
464
464
|
<aside class="tsd-sources">
|
|
465
465
|
<ul>
|
|
466
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
466
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L550">src/Application.ts:550</a></li></ul></aside></div></li></ul></section>
|
|
467
467
|
<section class="tsd-panel tsd-member">
|
|
468
468
|
<h3 class="tsd-anchor-link" id="getconfigfilepath"><span>get<wbr/>Config<wbr/>File<wbr/>Path</span><a href="#getconfigfilepath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
469
469
|
<ul class="tsd-signatures">
|
|
@@ -472,7 +472,7 @@ listeners.</p>
|
|
|
472
472
|
<div class="tsd-description">
|
|
473
473
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
474
474
|
<ul>
|
|
475
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
475
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L501">src/Application.ts:501</a></li></ul></aside></div></li></ul></section>
|
|
476
476
|
<section class="tsd-panel tsd-member">
|
|
477
477
|
<h3 class="tsd-anchor-link" id="getconfigfromcliargs"><span>get<wbr/>Config<wbr/>From<wbr/>CLI<wbr/>Args</span><a href="#getconfigfromcliargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
478
478
|
<ul class="tsd-signatures">
|
|
@@ -487,7 +487,7 @@ listeners.</p>
|
|
|
487
487
|
<li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span></span></li></ul></div>
|
|
488
488
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
489
489
|
<ul>
|
|
490
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
490
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L393">src/Application.ts:393</a></li></ul></aside></div></li></ul></section>
|
|
491
491
|
<section class="tsd-panel tsd-member">
|
|
492
492
|
<h3 class="tsd-anchor-link" id="getdb"><span>get<wbr/>DB</span><a href="#getdb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
493
493
|
<ul class="tsd-signatures">
|
|
@@ -497,7 +497,7 @@ listeners.</p>
|
|
|
497
497
|
<h4 class="tsd-returns-title">Returns <a href="Database.html" class="tsd-signature-type tsd-kind-class">Database</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span></h4><p>the database pool. This will need to be casted based on your preferred database dialect.</p>
|
|
498
498
|
<aside class="tsd-sources">
|
|
499
499
|
<ul>
|
|
500
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
500
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L586">src/Application.ts:586</a></li></ul></aside></div></li></ul></section>
|
|
501
501
|
<section class="tsd-panel tsd-member">
|
|
502
502
|
<h3 class="tsd-anchor-link" id="getdefaultportforprometheus"><span>get<wbr/>Default<wbr/>Port<wbr/>For<wbr/>Prometheus</span><a href="#getdefaultportforprometheus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
503
503
|
<ul class="tsd-signatures">
|
|
@@ -509,7 +509,7 @@ Still -- it is better to explicitly set the prometheus port.</p>
|
|
|
509
509
|
</div>
|
|
510
510
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
511
511
|
<ul>
|
|
512
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
512
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L167">src/Application.ts:167</a></li></ul></aside></div></li></ul></section>
|
|
513
513
|
<section class="tsd-panel tsd-member">
|
|
514
514
|
<h3 class="tsd-anchor-link" id="getlocalconfigfilepath"><span>get<wbr/>Local<wbr/>Config<wbr/>File<wbr/>Path</span><a href="#getlocalconfigfilepath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
515
515
|
<ul class="tsd-signatures">
|
|
@@ -518,7 +518,7 @@ Still -- it is better to explicitly set the prometheus port.</p>
|
|
|
518
518
|
<div class="tsd-description">
|
|
519
519
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
520
520
|
<ul>
|
|
521
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
521
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L505">src/Application.ts:505</a></li></ul></aside></div></li></ul></section>
|
|
522
522
|
<section class="tsd-panel tsd-member">
|
|
523
523
|
<h3 class="tsd-anchor-link" id="getlogger"><span>get<wbr/>Logger</span><a href="#getlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
524
524
|
<ul class="tsd-signatures">
|
|
@@ -527,7 +527,7 @@ Still -- it is better to explicitly set the prometheus port.</p>
|
|
|
527
527
|
<div class="tsd-description">
|
|
528
528
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BaseLogger</span></h4><aside class="tsd-sources">
|
|
529
529
|
<ul>
|
|
530
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
530
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L327">src/Application.ts:327</a></li></ul></aside></div></li></ul></section>
|
|
531
531
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
532
532
|
<h3 class="tsd-anchor-link" id="getmaxlisteners"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getmaxlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
533
533
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -545,7 +545,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
545
545
|
</div></div><aside class="tsd-sources">
|
|
546
546
|
<p>Inherited from EventEmitter.getMaxListeners</p>
|
|
547
547
|
<ul>
|
|
548
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
548
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:161</li></ul></aside></div></li></ul></section>
|
|
549
549
|
<section class="tsd-panel tsd-member">
|
|
550
550
|
<h3 class="tsd-anchor-link" id="getname"><span>get<wbr/>Name</span><a href="#getname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
551
551
|
<ul class="tsd-signatures">
|
|
@@ -555,7 +555,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
555
555
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the application name</p>
|
|
556
556
|
<aside class="tsd-sources">
|
|
557
557
|
<ul>
|
|
558
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
558
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L539">src/Application.ts:539</a></li></ul></aside></div></li></ul></section>
|
|
559
559
|
<section class="tsd-panel tsd-member">
|
|
560
560
|
<h3 class="tsd-anchor-link" id="getport"><span>get<wbr/>Port</span><a href="#getport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
561
561
|
<ul class="tsd-signatures">
|
|
@@ -564,7 +564,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
564
564
|
<div class="tsd-description">
|
|
565
565
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
566
566
|
<ul>
|
|
567
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
567
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L331">src/Application.ts:331</a></li></ul></aside></div></li></ul></section>
|
|
568
568
|
<section class="tsd-panel tsd-member">
|
|
569
569
|
<h3 class="tsd-anchor-link" id="getprogram"><span>get<wbr/>Program</span><a href="#getprogram" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
570
570
|
<ul class="tsd-signatures">
|
|
@@ -573,7 +573,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
573
573
|
<div class="tsd-description">
|
|
574
574
|
<h4 class="tsd-returns-title">Returns <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources">
|
|
575
575
|
<ul>
|
|
576
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
576
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L385">src/Application.ts:385</a></li></ul></aside></div></li></ul></section>
|
|
577
577
|
<section class="tsd-panel tsd-member">
|
|
578
578
|
<h3 class="tsd-anchor-link" id="getrequestsizelimit"><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span><a href="#getrequestsizelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
579
579
|
<ul class="tsd-signatures">
|
|
@@ -584,7 +584,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
584
584
|
</div>
|
|
585
585
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
586
586
|
<ul>
|
|
587
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
587
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L400">src/Application.ts:400</a></li></ul></aside></div></li></ul></section>
|
|
588
588
|
<section class="tsd-panel tsd-member">
|
|
589
589
|
<h3 class="tsd-anchor-link" id="getshard"><span>get<wbr/>Shard</span><a href="#getshard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
590
590
|
<ul class="tsd-signatures">
|
|
@@ -593,7 +593,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
593
593
|
<div class="tsd-description">
|
|
594
594
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
595
595
|
<ul>
|
|
596
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
596
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L375">src/Application.ts:375</a></li></ul></aside></div></li></ul></section>
|
|
597
597
|
<section class="tsd-panel tsd-member">
|
|
598
598
|
<h3 class="tsd-anchor-link" id="gettokenmanager"><span>get<wbr/>Token<wbr/>Manager</span><a href="#gettokenmanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
599
599
|
<ul class="tsd-signatures">
|
|
@@ -603,7 +603,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
603
603
|
<h4 class="tsd-returns-title">Returns <a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">></span></h4><p>the token manager</p>
|
|
604
604
|
<aside class="tsd-sources">
|
|
605
605
|
<ul>
|
|
606
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
606
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L579">src/Application.ts:579</a></li></ul></aside></div></li></ul></section>
|
|
607
607
|
<section class="tsd-panel tsd-member">
|
|
608
608
|
<h3 class="tsd-anchor-link" id="getversion"><span>get<wbr/>Version</span><a href="#getversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
609
609
|
<ul class="tsd-signatures">
|
|
@@ -612,7 +612,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
612
612
|
<div class="tsd-description">
|
|
613
613
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
614
614
|
<ul>
|
|
615
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
615
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L342">src/Application.ts:342</a></li></ul></aside></div></li></ul></section>
|
|
616
616
|
<section class="tsd-panel tsd-member">
|
|
617
617
|
<h3 class="tsd-anchor-link" id="isprometheusenabled"><span>is<wbr/>Prometheus<wbr/>Enabled</span><a href="#isprometheusenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
618
618
|
<ul class="tsd-signatures">
|
|
@@ -621,7 +621,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
|
621
621
|
<div class="tsd-description">
|
|
622
622
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
623
623
|
<ul>
|
|
624
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
624
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L379">src/Application.ts:379</a></li></ul></aside></div></li></ul></section>
|
|
625
625
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
626
626
|
<h3 class="tsd-anchor-link" id="listenercount"><span>listener<wbr/>Count</span><a href="#listenercount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
627
627
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -652,7 +652,7 @@ in the list of the listeners of the event.</p>
|
|
|
652
652
|
</div></div><aside class="tsd-sources">
|
|
653
653
|
<p>Inherited from EventEmitter.listenerCount</p>
|
|
654
654
|
<ul>
|
|
655
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
655
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:170</li></ul></aside></div></li></ul></section>
|
|
656
656
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
657
657
|
<h3 class="tsd-anchor-link" id="listeners"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
658
658
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -679,7 +679,7 @@ in the list of the listeners of the event.</p>
|
|
|
679
679
|
</div></div><aside class="tsd-sources">
|
|
680
680
|
<p>Inherited from EventEmitter.listeners</p>
|
|
681
681
|
<ul>
|
|
682
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
682
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:186</li></ul></aside></div></li></ul></section>
|
|
683
683
|
<section class="tsd-panel tsd-member">
|
|
684
684
|
<h3 class="tsd-anchor-link" id="loadconfig"><span class="deprecated">load<wbr/>Config</span><a href="#loadconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
685
685
|
<ul class="tsd-signatures">
|
|
@@ -698,7 +698,7 @@ in the list of the listeners of the event.</p>
|
|
|
698
698
|
<h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Supply the configs via --config and --local-config arguments</p>
|
|
699
699
|
</div></div><aside class="tsd-sources">
|
|
700
700
|
<ul>
|
|
701
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
701
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L479">src/Application.ts:479</a></li></ul></aside></div></li></ul></section>
|
|
702
702
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
703
703
|
<h3 class="tsd-anchor-link" id="off"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
704
704
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -723,7 +723,7 @@ in the list of the listeners of the event.</p>
|
|
|
723
723
|
</div></div><aside class="tsd-sources">
|
|
724
724
|
<p>Inherited from EventEmitter.off</p>
|
|
725
725
|
<ul>
|
|
726
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
726
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:191</li></ul></aside></div></li></ul></section>
|
|
727
727
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
728
728
|
<h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
729
729
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -766,7 +766,7 @@ event listener to the beginning of the listeners array.</p>
|
|
|
766
766
|
</div></div><aside class="tsd-sources">
|
|
767
767
|
<p>Inherited from EventEmitter.on</p>
|
|
768
768
|
<ul>
|
|
769
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
769
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:225</li></ul></aside></div></li></ul></section>
|
|
770
770
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
771
771
|
<h3 class="tsd-anchor-link" id="once"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
772
772
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -806,7 +806,7 @@ event listener to the beginning of the listeners array.</p>
|
|
|
806
806
|
</div></div><aside class="tsd-sources">
|
|
807
807
|
<p>Inherited from EventEmitter.once</p>
|
|
808
808
|
<ul>
|
|
809
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
809
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:256</li></ul></aside></div></li></ul></section>
|
|
810
810
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
811
811
|
<h3 class="tsd-anchor-link" id="prependlistener"><span>prepend<wbr/>Listener</span><a href="#prependlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
812
812
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -843,7 +843,7 @@ times.</p>
|
|
|
843
843
|
</div></div><aside class="tsd-sources">
|
|
844
844
|
<p>Inherited from EventEmitter.prependListener</p>
|
|
845
845
|
<ul>
|
|
846
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
846
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:275</li></ul></aside></div></li></ul></section>
|
|
847
847
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
848
848
|
<h3 class="tsd-anchor-link" id="prependoncelistener"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependoncelistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
849
849
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -878,7 +878,7 @@ listener is removed, and then invoked.</p>
|
|
|
878
878
|
</div></div><aside class="tsd-sources">
|
|
879
879
|
<p>Inherited from EventEmitter.prependOnceListener</p>
|
|
880
880
|
<ul>
|
|
881
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
881
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:292</li></ul></aside></div></li></ul></section>
|
|
882
882
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
883
883
|
<h3 class="tsd-anchor-link" id="rawlisteners"><span>raw<wbr/>Listeners</span><a href="#rawlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
884
884
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -906,7 +906,7 @@ including any wrappers (such as those created by <code>.once()</code>).</p>
|
|
|
906
906
|
</div></div><aside class="tsd-sources">
|
|
907
907
|
<p>Inherited from EventEmitter.rawListeners</p>
|
|
908
908
|
<ul>
|
|
909
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
909
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:326</li></ul></aside></div></li></ul></section>
|
|
910
910
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
911
911
|
<h3 class="tsd-anchor-link" id="removealllisteners"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removealllisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
912
912
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -934,7 +934,7 @@ component or module (e.g. sockets or file streams).</p>
|
|
|
934
934
|
</div></div><aside class="tsd-sources">
|
|
935
935
|
<p>Inherited from EventEmitter.removeAllListeners</p>
|
|
936
936
|
<ul>
|
|
937
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
937
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:338</li></ul></aside></div></li></ul></section>
|
|
938
938
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
939
939
|
<h3 class="tsd-anchor-link" id="removelistener"><span>remove<wbr/>Listener</span><a href="#removelistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
940
940
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -988,7 +988,7 @@ listener is removed:</p>
|
|
|
988
988
|
</div></div><aside class="tsd-sources">
|
|
989
989
|
<p>Inherited from EventEmitter.removeListener</p>
|
|
990
990
|
<ul>
|
|
991
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
991
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:425</li></ul></aside></div></li></ul></section>
|
|
992
992
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
993
993
|
<h3 class="tsd-anchor-link" id="setmaxlisteners"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setmaxlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
994
994
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -1013,7 +1013,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|
|
1013
1013
|
</div></div><aside class="tsd-sources">
|
|
1014
1014
|
<p>Inherited from EventEmitter.setMaxListeners</p>
|
|
1015
1015
|
<ul>
|
|
1016
|
-
<li>Defined in node_modules/.pnpm/@types+node@26.
|
|
1016
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.4.0/node_modules/@types/node/events.d.ts:436</li></ul></aside></div></li></ul></section>
|
|
1017
1017
|
<section class="tsd-panel tsd-member">
|
|
1018
1018
|
<h3 class="tsd-anchor-link" id="settokenmanager"><span>set<wbr/>Token<wbr/>Manager</span><a href="#settokenmanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1019
1019
|
<ul class="tsd-signatures">
|
|
@@ -1028,7 +1028,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|
|
1028
1028
|
<li><span><span class="tsd-kind-parameter">tokenManager</span>: <a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">></span></span></li></ul></div>
|
|
1029
1029
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1030
1030
|
<ul>
|
|
1031
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
1031
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L572">src/Application.ts:572</a></li></ul></aside></div></li></ul></section>
|
|
1032
1032
|
<section class="tsd-panel tsd-member">
|
|
1033
1033
|
<h3 class="tsd-anchor-link" id="shouldlisten"><span>should<wbr/>Listen</span><a href="#shouldlisten" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1034
1034
|
<ul class="tsd-signatures">
|
|
@@ -1038,7 +1038,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|
|
1038
1038
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the Application should bind to an IP address</p>
|
|
1039
1039
|
<aside class="tsd-sources">
|
|
1040
1040
|
<ul>
|
|
1041
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
1041
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L557">src/Application.ts:557</a></li></ul></aside></div></li></ul></section>
|
|
1042
1042
|
<section class="tsd-panel tsd-member">
|
|
1043
1043
|
<h3 class="tsd-anchor-link" id="start"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1044
1044
|
<ul class="tsd-signatures">
|
|
@@ -1047,7 +1047,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|
|
1047
1047
|
<div class="tsd-description">
|
|
1048
1048
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
1049
1049
|
<ul>
|
|
1050
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
1050
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/5755f1ee4ae7b9f2c0c0ff5e810da140b39f20aa/src/Application.ts#L131">src/Application.ts:131</a></li></ul></aside></div></li></ul></section></section></details></div>
|
|
1051
1051
|
<div class="col-sidebar">
|
|
1052
1052
|
<div class="page-menu">
|
|
1053
1053
|
<div class="tsd-navigation settings">
|