@breautek/storm 6.0.4 → 6.0.5
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 +8 -0
- package/docs/classes/Application.html +481 -444
- package/docs/classes/BackendAuthenticationMiddleware.html +99 -114
- package/docs/classes/CORSMiddleware.html +123 -136
- package/docs/classes/ConfigLoader.html +86 -105
- package/docs/classes/Database.html +141 -160
- package/docs/classes/DatabaseCastObject.html +100 -119
- package/docs/classes/DatabaseConnection.html +260 -250
- package/docs/classes/DatabaseQueryError.html +160 -175
- package/docs/classes/DeadLockError.html +162 -176
- package/docs/classes/DiskSpaceError.html +160 -175
- package/docs/classes/DropTemporaryTableQuery.html +133 -147
- package/docs/classes/DuplicateEntryError.html +160 -175
- package/docs/classes/EntityNotFoundError.html +160 -175
- package/docs/classes/ExpiredTokenError.html +160 -175
- package/docs/classes/Handler.html +146 -165
- package/docs/classes/InternalError.html +160 -175
- package/docs/classes/InvalidCredentialsError.html +160 -175
- package/docs/classes/InvalidValueError.html +160 -175
- package/docs/classes/LineString.html +101 -120
- package/docs/classes/LockWaitTimeoutError.html +162 -176
- package/docs/classes/ManagedDatabaseConnection.html +176 -195
- package/docs/classes/Middleware.html +96 -115
- package/docs/classes/MissingConfigError.html +160 -175
- package/docs/classes/MissingParameterError.html +160 -175
- package/docs/classes/MySQLConnection.html +265 -255
- package/docs/classes/MySQLDatabase.html +146 -165
- package/docs/classes/NotImplementedError.html +160 -175
- package/docs/classes/Point.html +101 -120
- package/docs/classes/Polygon.html +101 -120
- package/docs/classes/Query.html +133 -147
- package/docs/classes/RawError.html +162 -176
- package/docs/classes/RawQuery.html +133 -147
- package/docs/classes/Request.html +171 -190
- package/docs/classes/Response.html +136 -155
- package/docs/classes/ResponseData.html +116 -135
- package/docs/classes/ServiceProvider.html +156 -175
- package/docs/classes/ServiceResponse.html +106 -125
- package/docs/classes/SetSessionVariableQuery.html +133 -147
- package/docs/classes/StormError.html +160 -175
- package/docs/classes/TemporaryTableQuery.html +133 -147
- package/docs/classes/Token.html +91 -110
- package/docs/classes/TokenManager.html +101 -120
- package/docs/classes/Transaction.html +113 -131
- package/docs/classes/UnauthorizedAccessError.html +160 -175
- package/docs/enums/ErrorCode.html +117 -136
- package/docs/enums/ExitCode.html +89 -108
- package/docs/enums/HTTPMethod.html +97 -116
- package/docs/enums/IsolationLevel.html +97 -116
- package/docs/enums/JWTError.html +89 -108
- package/docs/enums/StatusCode.html +273 -292
- package/docs/functions/formidable-1.html +80 -99
- package/docs/functions/getInstance.html +84 -103
- package/docs/index.html +156 -175
- package/docs/interfaces/IAdditionalErrorDetails.html +80 -99
- package/docs/interfaces/IAuthTokenData.html +89 -108
- package/docs/interfaces/ICloudwatchConfig.html +93 -112
- package/docs/interfaces/ICloudwatchCredentials.html +89 -108
- package/docs/interfaces/ICloudwatchStreamConfig.html +89 -108
- package/docs/interfaces/IConfig.html +113 -132
- package/docs/interfaces/IDatabaseConfig.html +105 -124
- package/docs/interfaces/IDatabaseConnection.html +151 -170
- package/docs/interfaces/IErrorResponse.html +101 -120
- package/docs/interfaces/IFormData.html +89 -108
- package/docs/interfaces/IHandler.html +86 -105
- package/docs/interfaces/IInsertQueryResult.html +93 -112
- package/docs/interfaces/IJWTVerifyOptions.html +85 -104
- package/docs/interfaces/IParameterMap.html +80 -99
- package/docs/interfaces/IQueryable.html +106 -125
- package/docs/interfaces/IRequestResponse.html +89 -108
- package/docs/interfaces/IServiceHeaders.html +80 -99
- package/docs/interfaces/ISetSessionVariableQueryInput.html +89 -108
- package/docs/interfaces/ITemporaryTableQueryInput.html +89 -108
- package/docs/interfaces/IUpdateQueryResult.html +89 -108
- package/docs/interfaces/formidable.EmitData.html +108 -108
- package/docs/interfaces/formidable.EventData.html +117 -117
- package/docs/interfaces/formidable.Fields.html +95 -95
- package/docs/interfaces/formidable.File.html +138 -131
- package/docs/interfaces/formidable.FileJSON.html +134 -129
- package/docs/interfaces/formidable.Files.html +95 -95
- package/docs/interfaces/formidable.Options.html +167 -156
- package/docs/interfaces/formidable.Part.html +248 -223
- package/docs/modules/formidable.html +111 -111
- package/docs/types/IDeleteQueryResult.html +80 -99
- package/docs/types/IHandlerError.html +82 -100
- package/docs/types/IHandlerResponse.html +82 -100
- package/docs/types/TCoordinate.html +80 -99
- package/docs/types/formidable.BufferEncoding.html +95 -95
- package/docs/types/formidable.DefaultOptions.html +101 -96
- package/docs/types/formidable.EnabledPlugins.html +95 -95
- package/docs/types/formidable.EventNames.html +95 -95
- package/docs/types/formidable.MappedParsers.html +95 -95
- package/docs/types/formidable.Plugin.html +95 -95
- package/docs/types/formidable.PluginFunction.html +95 -95
- package/docs/types/formidable.Plugins.html +95 -95
- package/lib/Application.d.ts +1 -1
- package/lib/Application.js +7 -6
- package/lib/Application.js.map +1 -1
- package/package.json +13 -13
- package/src/Application.ts +7 -6
|
@@ -17,7 +17,8 @@
|
|
|
17
17
|
<h1>Class Application<TConfig, TAuthToken, TDBConfig, TDBConnectionAPI><code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div>
|
|
18
18
|
<section class="tsd-panel tsd-comment">
|
|
19
19
|
<div class="tsd-comment tsd-typography"><p>Main entry point for the Application. Should be extended and have the abstract methods implemented.</p>
|
|
20
|
-
</div
|
|
20
|
+
</div>
|
|
21
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
21
22
|
<section class="tsd-panel">
|
|
22
23
|
<h4>Type Parameters</h4>
|
|
23
24
|
<ul class="tsd-type-parameter-list">
|
|
@@ -36,7 +37,7 @@
|
|
|
36
37
|
<ul class="tsd-hierarchy">
|
|
37
38
|
<li><span class="target">Application</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
38
39
|
<ul>
|
|
39
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
40
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L45">src/Application.ts:45</a></li></ul></aside>
|
|
40
41
|
<section class="tsd-panel-group tsd-index-group">
|
|
41
42
|
<section class="tsd-panel tsd-index-panel">
|
|
42
43
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -44,71 +45,71 @@
|
|
|
44
45
|
<div class="tsd-accordion-details">
|
|
45
46
|
<section class="tsd-index-section">
|
|
46
47
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
47
|
-
<div class="tsd-index-list"><a href="Application.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
48
|
+
<div class="tsd-index-list"><a href="Application.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
|
|
48
49
|
</div></section>
|
|
49
50
|
<section class="tsd-index-section">
|
|
50
51
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
51
|
-
<div class="tsd-index-list"><a href="Application.html#captureRejectionSymbol" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
52
|
-
<a href="Application.html#captureRejections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
53
|
-
<a href="Application.html#defaultMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
54
|
-
<a href="Application.html#errorMonitor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
52
|
+
<div class="tsd-index-list"><a href="Application.html#captureRejectionSymbol" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a>
|
|
53
|
+
<a href="Application.html#captureRejections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejections</span></a>
|
|
54
|
+
<a href="Application.html#defaultMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a>
|
|
55
|
+
<a href="Application.html#errorMonitor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error<wbr/>Monitor</span></a>
|
|
55
56
|
</div></section>
|
|
56
57
|
<section class="tsd-index-section">
|
|
57
58
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
58
|
-
<div class="tsd-index-list"><a href="Application.html#_attachHandlers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
59
|
-
<a href="Application.html#_buildArgOptions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
60
|
-
<a href="Application.html#_closeDatabase" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
61
|
-
<a href="Application.html#_closeSocket" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
62
|
-
<a href="Application.html#_createLogger" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
63
|
-
<a href="Application.html#_initDB" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
64
|
-
<a href="Application.html#_initLogger" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
65
|
-
<a href="Application.html#_initialize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
66
|
-
<a href="Application.html#_onBeforeReadyAsync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
67
|
-
<a href="Application.html#_onConfigLoad" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
68
|
-
<a href="Application.html#_onReady" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon"
|
|
69
|
-
<a href="Application.html#addListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
70
|
-
<a href="Application.html#attachHandler" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
71
|
-
<a href="Application.html#attachHandlerInstance" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
72
|
-
<a href="Application.html#close" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
73
|
-
<a href="Application.html#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
74
|
-
<a href="Application.html#eventNames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
75
|
-
<a href="Application.html#getCmdLineArgs" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
76
|
-
<a href="Application.html#getConfig" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
77
|
-
<a href="Application.html#getDB" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
78
|
-
<a href="Application.html#getLogger" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
79
|
-
<a href="Application.html#getMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
80
|
-
<a href="Application.html#getName" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
81
|
-
<a href="Application.html#getPort" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
82
|
-
<a href="Application.html#getProgram" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
83
|
-
<a href="Application.html#getRequestSizeLimit" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
84
|
-
<a href="Application.html#getTokenManager" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
85
|
-
<a href="Application.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
86
|
-
<a href="Application.html#listeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
87
|
-
<a href="Application.html#loadConfig" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
88
|
-
<a href="Application.html#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
89
|
-
<a href="Application.html#on" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
90
|
-
<a href="Application.html#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
91
|
-
<a href="Application.html#prependListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
92
|
-
<a href="Application.html#prependOnceListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
93
|
-
<a href="Application.html#rawListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
94
|
-
<a href="Application.html#removeAllListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
95
|
-
<a href="Application.html#removeListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
96
|
-
<a href="Application.html#setMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
97
|
-
<a href="Application.html#setTokenManager" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
98
|
-
<a href="Application.html#shouldListen" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
99
|
-
<a href="Application.html#start" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
100
|
-
<a href="Application.html#getEventListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
101
|
-
<a href="Application.html#listenerCount-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
102
|
-
<a href="Application.html#on-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
103
|
-
<a href="Application.html#once-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
104
|
-
<a href="Application.html#setMaxListeners-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
59
|
+
<div class="tsd-index-list"><a href="Application.html#_attachHandlers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>_attach<wbr/>Handlers</span></a>
|
|
60
|
+
<a href="Application.html#_buildArgOptions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_build<wbr/>Arg<wbr/>Options</span></a>
|
|
61
|
+
<a href="Application.html#_closeDatabase" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_close<wbr/>Database</span></a>
|
|
62
|
+
<a href="Application.html#_closeSocket" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_close<wbr/>Socket</span></a>
|
|
63
|
+
<a href="Application.html#_createLogger" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_create<wbr/>Logger</span></a>
|
|
64
|
+
<a href="Application.html#_initDB" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_initDB</span></a>
|
|
65
|
+
<a href="Application.html#_initLogger" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_init<wbr/>Logger</span></a>
|
|
66
|
+
<a href="Application.html#_initialize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_initialize</span></a>
|
|
67
|
+
<a href="Application.html#_onBeforeReadyAsync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Before<wbr/>Ready<wbr/>Async</span></a>
|
|
68
|
+
<a href="Application.html#_onConfigLoad" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Config<wbr/>Load</span></a>
|
|
69
|
+
<a href="Application.html#_onReady" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Ready</span></a>
|
|
70
|
+
<a href="Application.html#addListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
|
71
|
+
<a href="Application.html#attachHandler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>attach<wbr/>Handler</span></a>
|
|
72
|
+
<a href="Application.html#attachHandlerInstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>attach<wbr/>Handler<wbr/>Instance</span></a>
|
|
73
|
+
<a href="Application.html#close" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close</span></a>
|
|
74
|
+
<a href="Application.html#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a>
|
|
75
|
+
<a href="Application.html#eventNames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a>
|
|
76
|
+
<a href="Application.html#getCmdLineArgs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span></a>
|
|
77
|
+
<a href="Application.html#getConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Config</span></a>
|
|
78
|
+
<a href="Application.html#getDB" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getDB</span></a>
|
|
79
|
+
<a href="Application.html#getLogger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Logger</span></a>
|
|
80
|
+
<a href="Application.html#getMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a>
|
|
81
|
+
<a href="Application.html#getName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Name</span></a>
|
|
82
|
+
<a href="Application.html#getPort" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Port</span></a>
|
|
83
|
+
<a href="Application.html#getProgram" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Program</span></a>
|
|
84
|
+
<a href="Application.html#getRequestSizeLimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span></a>
|
|
85
|
+
<a href="Application.html#getTokenManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Manager</span></a>
|
|
86
|
+
<a href="Application.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
|
87
|
+
<a href="Application.html#listeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a>
|
|
88
|
+
<a href="Application.html#loadConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Config</span></a>
|
|
89
|
+
<a href="Application.html#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
|
|
90
|
+
<a href="Application.html#on" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
|
91
|
+
<a href="Application.html#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a>
|
|
92
|
+
<a href="Application.html#prependListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a>
|
|
93
|
+
<a href="Application.html#prependOnceListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a>
|
|
94
|
+
<a href="Application.html#rawListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a>
|
|
95
|
+
<a href="Application.html#removeAllListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
|
96
|
+
<a href="Application.html#removeListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a>
|
|
97
|
+
<a href="Application.html#setMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
|
98
|
+
<a href="Application.html#setTokenManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Token<wbr/>Manager</span></a>
|
|
99
|
+
<a href="Application.html#shouldListen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>should<wbr/>Listen</span></a>
|
|
100
|
+
<a href="Application.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a>
|
|
101
|
+
<a href="Application.html#getEventListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Listeners</span></a>
|
|
102
|
+
<a href="Application.html#listenerCount-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
|
103
|
+
<a href="Application.html#on-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
|
104
|
+
<a href="Application.html#once-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a>
|
|
105
|
+
<a href="Application.html#setMaxListeners-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
|
105
106
|
</div></section></div></details></section></section>
|
|
106
107
|
<section class="tsd-panel-group tsd-member-group">
|
|
107
108
|
<h2>Constructors</h2>
|
|
108
109
|
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
109
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
110
|
+
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
110
111
|
<ul class="tsd-signatures">
|
|
111
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Application"><span class="tsd-kind-constructor-signature">new <wbr/>Application</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">configPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_Application" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
112
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Application"><span class="tsd-kind-constructor-signature">new <wbr/>Application</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">configPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_Application" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
112
113
|
<li class="tsd-description">
|
|
113
114
|
<section class="tsd-panel">
|
|
114
115
|
<h4>Type Parameters</h4>
|
|
@@ -127,41 +128,46 @@
|
|
|
127
128
|
<li>
|
|
128
129
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
129
130
|
<div class="tsd-comment tsd-typography"><p>The application name</p>
|
|
130
|
-
</div
|
|
131
|
+
</div>
|
|
132
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
131
133
|
<li>
|
|
132
134
|
<h5><span class="tsd-kind-parameter">configPath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
133
135
|
<div class="tsd-comment tsd-typography"><p>The directory where bt-config.json and bt-local-config.json can be found. Defaults to current working directory.</p>
|
|
134
|
-
</div
|
|
135
|
-
<
|
|
136
|
+
</div>
|
|
137
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
138
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
139
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
136
140
|
<p>Overrides EventEmitter.constructor</p>
|
|
137
141
|
<ul>
|
|
138
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
142
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L68">src/Application.ts:68</a></li></ul></aside></li></ul></section></section>
|
|
139
143
|
<section class="tsd-panel-group tsd-member-group">
|
|
140
144
|
<h2>Properties</h2>
|
|
141
145
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
|
142
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
146
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
143
147
|
<div class="tsd-signature"><span class="tsd-kind-property">capture<wbr/>Rejection<wbr/>Symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Application.html#captureRejectionSymbol" class="tsd-signature-type tsd-kind-property">captureRejectionSymbol</a></div>
|
|
144
148
|
<div class="tsd-comment tsd-typography"><p>Value: <code>Symbol.for('nodejs.rejection')</code></p>
|
|
145
149
|
<p>See how to write a custom <code>rejection handler</code>.</p>
|
|
146
|
-
|
|
147
|
-
<
|
|
150
|
+
</div>
|
|
151
|
+
<div class="tsd-comment tsd-typography">
|
|
152
|
+
<h4>Since</h4><p>v13.4.0, v12.16.0</p>
|
|
148
153
|
</div><aside class="tsd-sources">
|
|
149
154
|
<p>Inherited from EventEmitter.captureRejectionSymbol</p>
|
|
150
155
|
<ul>
|
|
151
156
|
<li>Defined in node_modules/@types/node/events.d.ts:326</li></ul></aside></section>
|
|
152
157
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a>
|
|
153
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Rejections</span><a href="#captureRejections" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
158
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Rejections</span><a href="#captureRejections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
154
159
|
<div class="tsd-signature"><span class="tsd-kind-property">capture<wbr/>Rejections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
155
160
|
<div class="tsd-comment tsd-typography"><p>Value: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type">boolean</a></p>
|
|
156
161
|
<p>Change the default <code>captureRejections</code> option on all new <code>EventEmitter</code> objects.</p>
|
|
157
|
-
|
|
158
|
-
<
|
|
162
|
+
</div>
|
|
163
|
+
<div class="tsd-comment tsd-typography">
|
|
164
|
+
<h4>Since</h4><p>v13.4.0, v12.16.0</p>
|
|
159
165
|
</div><aside class="tsd-sources">
|
|
160
166
|
<p>Inherited from EventEmitter.captureRejections</p>
|
|
161
167
|
<ul>
|
|
162
168
|
<li>Defined in node_modules/@types/node/events.d.ts:333</li></ul></aside></section>
|
|
163
169
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a>
|
|
164
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>default<wbr/>Max<wbr/>Listeners</span><a href="#defaultMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
170
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>default<wbr/>Max<wbr/>Listeners</span><a href="#defaultMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
165
171
|
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
166
172
|
<div class="tsd-comment tsd-typography"><p>By default, a maximum of <code>10</code> listeners can be registered for any single
|
|
167
173
|
event. This limit can be changed for individual <code>EventEmitter</code> instances
|
|
@@ -184,20 +190,22 @@ have the additional <code>emitter</code>, <code>type</code>, and <code>count</co
|
|
|
184
190
|
the event emitter instance, the event's name and the number of attached
|
|
185
191
|
listeners, respectively.
|
|
186
192
|
Its <code>name</code> property is set to <code>'MaxListenersExceededWarning'</code>.</p>
|
|
187
|
-
|
|
188
|
-
<
|
|
193
|
+
</div>
|
|
194
|
+
<div class="tsd-comment tsd-typography">
|
|
195
|
+
<h4>Since</h4><p>v0.11.2</p>
|
|
189
196
|
</div><aside class="tsd-sources">
|
|
190
197
|
<p>Inherited from EventEmitter.defaultMaxListeners</p>
|
|
191
198
|
<ul>
|
|
192
199
|
<li>Defined in node_modules/@types/node/events.d.ts:370</li></ul></aside></section>
|
|
193
200
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a>
|
|
194
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>error<wbr/>Monitor</span><a href="#errorMonitor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
201
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>error<wbr/>Monitor</span><a href="#errorMonitor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
195
202
|
<div class="tsd-signature"><span class="tsd-kind-property">error<wbr/>Monitor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Application.html#errorMonitor" class="tsd-signature-type tsd-kind-property">errorMonitor</a></div>
|
|
196
203
|
<div class="tsd-comment tsd-typography"><p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>events. Listeners installed using this symbol are called before the regular<code>'error'</code> listeners are called.</p>
|
|
197
204
|
<p>Installing a listener using this symbol does not change the behavior once an<code>'error'</code> event is emitted. Therefore, the process will still crash if no
|
|
198
205
|
regular <code>'error'</code> listener is installed.</p>
|
|
199
|
-
|
|
200
|
-
<
|
|
206
|
+
</div>
|
|
207
|
+
<div class="tsd-comment tsd-typography">
|
|
208
|
+
<h4>Since</h4><p>v13.6.0, v12.17.0</p>
|
|
201
209
|
</div><aside class="tsd-sources">
|
|
202
210
|
<p>Inherited from EventEmitter.errorMonitor</p>
|
|
203
211
|
<ul>
|
|
@@ -205,20 +213,21 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
205
213
|
<section class="tsd-panel-group tsd-member-group">
|
|
206
214
|
<h2>Methods</h2>
|
|
207
215
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_attachHandlers" class="tsd-anchor"></a>
|
|
208
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>_attach<wbr/>Handlers</span><a href="#_attachHandlers" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
216
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>_attach<wbr/>Handlers</span><a href="#_attachHandlers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
209
217
|
<ul class="tsd-signatures tsd-is-protected">
|
|
210
|
-
<li class="tsd-signature tsd-anchor-link" id="_attachHandlers._attachHandlers-1"><span class="tsd-kind-call-signature">_attach<wbr/>Handlers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_attachHandlers._attachHandlers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
218
|
+
<li class="tsd-signature tsd-anchor-link" id="_attachHandlers._attachHandlers-1"><span class="tsd-kind-call-signature">_attach<wbr/>Handlers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_attachHandlers._attachHandlers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
211
219
|
<li class="tsd-description">
|
|
212
220
|
<div class="tsd-comment tsd-typography"><p>Subclasses are expected to attach the API handlers for their service. This will be invoked during application startup.</p>
|
|
213
221
|
</div>
|
|
214
222
|
<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>
|
|
215
|
-
|
|
223
|
+
|
|
224
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
216
225
|
<ul>
|
|
217
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
226
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L346">src/Application.ts:346</a></li></ul></aside></li></ul></section>
|
|
218
227
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_buildArgOptions" class="tsd-anchor"></a>
|
|
219
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_build<wbr/>Arg<wbr/>Options</span><a href="#_buildArgOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
228
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_build<wbr/>Arg<wbr/>Options</span><a href="#_buildArgOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
220
229
|
<ul class="tsd-signatures tsd-is-protected">
|
|
221
|
-
<li class="tsd-signature tsd-anchor-link" id="_buildArgOptions._buildArgOptions-1"><span class="tsd-kind-call-signature">_build<wbr/>Arg<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">program</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_buildArgOptions._buildArgOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
230
|
+
<li class="tsd-signature tsd-anchor-link" id="_buildArgOptions._buildArgOptions-1"><span class="tsd-kind-call-signature">_build<wbr/>Arg<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">program</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_buildArgOptions._buildArgOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
222
231
|
<li class="tsd-description">
|
|
223
232
|
<div class="tsd-parameters">
|
|
224
233
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -227,27 +236,27 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
227
236
|
<h5><span class="tsd-kind-parameter">program</span>: <span class="tsd-signature-type ">Command</span></h5></li></ul></div>
|
|
228
237
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
229
238
|
<ul>
|
|
230
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
239
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L273">src/Application.ts:273</a></li></ul></aside></li></ul></section>
|
|
231
240
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_closeDatabase" class="tsd-anchor"></a>
|
|
232
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_close<wbr/>Database</span><a href="#_closeDatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
241
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_close<wbr/>Database</span><a href="#_closeDatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
233
242
|
<ul class="tsd-signatures tsd-is-protected">
|
|
234
|
-
<li class="tsd-signature tsd-anchor-link" id="_closeDatabase._closeDatabase-1"><span class="tsd-kind-call-signature">_close<wbr/>Database</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_closeDatabase._closeDatabase-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
243
|
+
<li class="tsd-signature tsd-anchor-link" id="_closeDatabase._closeDatabase-1"><span class="tsd-kind-call-signature">_close<wbr/>Database</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_closeDatabase._closeDatabase-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
235
244
|
<li class="tsd-description">
|
|
236
245
|
<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">
|
|
237
246
|
<ul>
|
|
238
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
247
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L323">src/Application.ts:323</a></li></ul></aside></li></ul></section>
|
|
239
248
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_closeSocket" class="tsd-anchor"></a>
|
|
240
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_close<wbr/>Socket</span><a href="#_closeSocket" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
249
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_close<wbr/>Socket</span><a href="#_closeSocket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
241
250
|
<ul class="tsd-signatures tsd-is-protected">
|
|
242
|
-
<li class="tsd-signature tsd-anchor-link" id="_closeSocket._closeSocket-1"><span class="tsd-kind-call-signature">_close<wbr/>Socket</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_closeSocket._closeSocket-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
251
|
+
<li class="tsd-signature tsd-anchor-link" id="_closeSocket._closeSocket-1"><span class="tsd-kind-call-signature">_close<wbr/>Socket</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_closeSocket._closeSocket-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
243
252
|
<li class="tsd-description">
|
|
244
253
|
<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">
|
|
245
254
|
<ul>
|
|
246
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
255
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L329">src/Application.ts:329</a></li></ul></aside></li></ul></section>
|
|
247
256
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_createLogger" class="tsd-anchor"></a>
|
|
248
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_create<wbr/>Logger</span><a href="#_createLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
257
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_create<wbr/>Logger</span><a href="#_createLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
249
258
|
<ul class="tsd-signatures tsd-is-protected">
|
|
250
|
-
<li class="tsd-signature tsd-anchor-link" id="_createLogger._createLogger-1"><span class="tsd-kind-call-signature">_create<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BaseLogger</span><a href="#_createLogger._createLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
259
|
+
<li class="tsd-signature tsd-anchor-link" id="_createLogger._createLogger-1"><span class="tsd-kind-call-signature">_create<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BaseLogger</span><a href="#_createLogger._createLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
251
260
|
<li class="tsd-description">
|
|
252
261
|
<div class="tsd-parameters">
|
|
253
262
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -256,11 +265,11 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
256
265
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h5></li></ul></div>
|
|
257
266
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">BaseLogger</span></h4><aside class="tsd-sources">
|
|
258
267
|
<ul>
|
|
259
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
268
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L171">src/Application.ts:171</a></li></ul></aside></li></ul></section>
|
|
260
269
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_initDB" class="tsd-anchor"></a>
|
|
261
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_initDB</span><a href="#_initDB" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
270
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_initDB</span><a href="#_initDB" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
262
271
|
<ul class="tsd-signatures tsd-is-protected">
|
|
263
|
-
<li class="tsd-signature tsd-anchor-link" id="_initDB._initDB-1"><span class="tsd-kind-call-signature">_initDB</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#_initDB._initDB-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
272
|
+
<li class="tsd-signature tsd-anchor-link" id="_initDB._initDB-1"><span class="tsd-kind-call-signature">_initDB</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#_initDB._initDB-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
264
273
|
<li class="tsd-description">
|
|
265
274
|
<div class="tsd-comment tsd-typography"><p>Subclasses are expected to override this to configure their database setup, if the service uses a database.</p>
|
|
266
275
|
</div>
|
|
@@ -270,27 +279,29 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
270
279
|
<li>
|
|
271
280
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h5>
|
|
272
281
|
<div class="tsd-comment tsd-typography"><p>The bt-config object</p>
|
|
273
|
-
</div
|
|
274
|
-
<
|
|
282
|
+
</div>
|
|
283
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
284
|
+
<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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
285
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
275
286
|
<ul>
|
|
276
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
287
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L455">src/Application.ts:455</a></li></ul></aside></li></ul></section>
|
|
277
288
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_initLogger" class="tsd-anchor"></a>
|
|
278
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_init<wbr/>Logger</span><a href="#_initLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
289
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_init<wbr/>Logger</span><a href="#_initLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
279
290
|
<ul class="tsd-signatures tsd-is-protected">
|
|
280
|
-
<li class="tsd-signature tsd-anchor-link" id="_initLogger._initLogger-1"><span class="tsd-kind-call-signature">_init<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BaseLogger</span><a href="#_initLogger._initLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
291
|
+
<li class="tsd-signature tsd-anchor-link" id="_initLogger._initLogger-1"><span class="tsd-kind-call-signature">_init<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_initLogger._initLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
281
292
|
<li class="tsd-description">
|
|
282
293
|
<div class="tsd-parameters">
|
|
283
294
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
284
295
|
<ul class="tsd-parameter-list">
|
|
285
296
|
<li>
|
|
286
297
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h5></li></ul></div>
|
|
287
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">BaseLogger</span></h4><aside class="tsd-sources">
|
|
298
|
+
<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">
|
|
288
299
|
<ul>
|
|
289
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
300
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L175">src/Application.ts:175</a></li></ul></aside></li></ul></section>
|
|
290
301
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_initialize" class="tsd-anchor"></a>
|
|
291
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_initialize</span><a href="#_initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
302
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_initialize</span><a href="#_initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
292
303
|
<ul class="tsd-signatures tsd-is-protected">
|
|
293
|
-
<li class="tsd-signature tsd-anchor-link" id="_initialize._initialize-1"><span class="tsd-kind-call-signature">_initialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_initialize._initialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
304
|
+
<li class="tsd-signature tsd-anchor-link" id="_initialize._initialize-1"><span class="tsd-kind-call-signature">_initialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_initialize._initialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
294
305
|
<li class="tsd-description">
|
|
295
306
|
<div class="tsd-parameters">
|
|
296
307
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -299,19 +310,19 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
299
310
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h5></li></ul></div>
|
|
300
311
|
<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">
|
|
301
312
|
<ul>
|
|
302
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
313
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L167">src/Application.ts:167</a></li></ul></aside></li></ul></section>
|
|
303
314
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_onBeforeReadyAsync" class="tsd-anchor"></a>
|
|
304
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Before<wbr/>Ready<wbr/>Async</span><a href="#_onBeforeReadyAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
315
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Before<wbr/>Ready<wbr/>Async</span><a href="#_onBeforeReadyAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
305
316
|
<ul class="tsd-signatures tsd-is-protected">
|
|
306
|
-
<li class="tsd-signature tsd-anchor-link" id="_onBeforeReadyAsync._onBeforeReadyAsync-1"><span class="tsd-kind-call-signature">_on<wbr/>Before<wbr/>Ready<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_onBeforeReadyAsync._onBeforeReadyAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
317
|
+
<li class="tsd-signature tsd-anchor-link" id="_onBeforeReadyAsync._onBeforeReadyAsync-1"><span class="tsd-kind-call-signature">_on<wbr/>Before<wbr/>Ready<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#_onBeforeReadyAsync._onBeforeReadyAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
307
318
|
<li class="tsd-description">
|
|
308
319
|
<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">
|
|
309
320
|
<ul>
|
|
310
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
321
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L459">src/Application.ts:459</a></li></ul></aside></li></ul></section>
|
|
311
322
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_onConfigLoad" class="tsd-anchor"></a>
|
|
312
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Config<wbr/>Load</span><a href="#_onConfigLoad" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
323
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Config<wbr/>Load</span><a href="#_onConfigLoad" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
313
324
|
<ul class="tsd-signatures tsd-is-protected">
|
|
314
|
-
<li class="tsd-signature tsd-anchor-link" id="_onConfigLoad._onConfigLoad-1"><span class="tsd-kind-call-signature">_on<wbr/>Config<wbr/>Load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_onConfigLoad._onConfigLoad-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
325
|
+
<li class="tsd-signature tsd-anchor-link" id="_onConfigLoad._onConfigLoad-1"><span class="tsd-kind-call-signature">_on<wbr/>Config<wbr/>Load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_onConfigLoad._onConfigLoad-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
315
326
|
<li class="tsd-description">
|
|
316
327
|
<div class="tsd-comment tsd-typography"><p>Invoked once the config has been loaded and ready to be used.</p>
|
|
317
328
|
</div>
|
|
@@ -321,28 +332,29 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
321
332
|
<li>
|
|
322
333
|
<h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h5>
|
|
323
334
|
<div class="tsd-comment tsd-typography"><p>The config object (as defined in bt-config.json/bt-local-config.json)</p>
|
|
324
|
-
</div
|
|
325
|
-
<
|
|
335
|
+
</div>
|
|
336
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
337
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
338
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
326
339
|
<ul>
|
|
327
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
340
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L399">src/Application.ts:399</a></li></ul></aside></li></ul></section>
|
|
328
341
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_onReady" class="tsd-anchor"></a>
|
|
329
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Ready</span><a href="#_onReady" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
342
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_on<wbr/>Ready</span><a href="#_onReady" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
330
343
|
<ul class="tsd-signatures tsd-is-protected">
|
|
331
|
-
<li class="tsd-signature tsd-anchor-link" id="_onReady._onReady-1"><span class="tsd-kind-call-signature">_on<wbr/>Ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_onReady._onReady-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
344
|
+
<li class="tsd-signature tsd-anchor-link" id="_onReady._onReady-1"><span class="tsd-kind-call-signature">_on<wbr/>Ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_onReady._onReady-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
332
345
|
<li class="tsd-description">
|
|
333
346
|
<div class="tsd-comment tsd-typography"><p>Invoked when the application is considered ready for operation.</p>
|
|
334
347
|
</div>
|
|
335
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
348
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
349
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
336
350
|
<ul>
|
|
337
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
351
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L464">src/Application.ts:464</a></li></ul></aside></li></ul></section>
|
|
338
352
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
|
|
339
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
353
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
340
354
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
341
|
-
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#addListener.addListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
355
|
+
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#addListener.addListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
342
356
|
<li class="tsd-description">
|
|
343
357
|
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
|
|
344
|
-
|
|
345
|
-
<h3>Since</h3><p>v0.1.26</p>
|
|
346
358
|
</div>
|
|
347
359
|
<div class="tsd-parameters">
|
|
348
360
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -362,14 +374,17 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
362
374
|
<li>
|
|
363
375
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
364
376
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
365
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
377
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
378
|
+
<div class="tsd-comment tsd-typography">
|
|
379
|
+
<h4>Since</h4><p>v0.1.26</p>
|
|
380
|
+
</div><aside class="tsd-sources">
|
|
366
381
|
<p>Inherited from EventEmitter.addListener</p>
|
|
367
382
|
<ul>
|
|
368
383
|
<li>Defined in node_modules/@types/node/events.d.ts:390</li></ul></aside></li></ul></section>
|
|
369
384
|
<section class="tsd-panel tsd-member"><a id="attachHandler" class="tsd-anchor"></a>
|
|
370
|
-
<h3 class="tsd-anchor-link"><span>attach<wbr/>Handler</span><a href="#attachHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
385
|
+
<h3 class="tsd-anchor-link"><span>attach<wbr/>Handler</span><a href="#attachHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
371
386
|
<ul class="tsd-signatures">
|
|
372
|
-
<li class="tsd-signature tsd-anchor-link" id="attachHandler.attachHandler-1"><span class="tsd-kind-call-signature">attach<wbr/>Handler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">HandlerClass</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#attachHandler.attachHandler-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
387
|
+
<li class="tsd-signature tsd-anchor-link" id="attachHandler.attachHandler-1"><span class="tsd-kind-call-signature">attach<wbr/>Handler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">HandlerClass</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#attachHandler.attachHandler-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
373
388
|
<li class="tsd-description">
|
|
374
389
|
<div class="tsd-parameters">
|
|
375
390
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -377,18 +392,21 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
377
392
|
<li>
|
|
378
393
|
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5>
|
|
379
394
|
<div class="tsd-comment tsd-typography"><p>The URL API path. E.g. /api/myService/myCommand/</p>
|
|
380
|
-
</div
|
|
395
|
+
</div>
|
|
396
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
381
397
|
<li>
|
|
382
398
|
<h5><span class="tsd-kind-parameter">HandlerClass</span>: <a href="../interfaces/IHandler.html" class="tsd-signature-type tsd-kind-interface">IHandler</a><span class="tsd-signature-symbol"><</span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5>
|
|
383
399
|
<div class="tsd-comment tsd-typography"><p>The concrete class (not the instance) of Handler to be used for this API.</p>
|
|
384
|
-
</div
|
|
385
|
-
<
|
|
400
|
+
</div>
|
|
401
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
402
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
403
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
386
404
|
<ul>
|
|
387
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
405
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L292">src/Application.ts:292</a></li></ul></aside></li></ul></section>
|
|
388
406
|
<section class="tsd-panel tsd-member"><a id="attachHandlerInstance" class="tsd-anchor"></a>
|
|
389
|
-
<h3 class="tsd-anchor-link"><span>attach<wbr/>Handler<wbr/>Instance</span><a href="#attachHandlerInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
407
|
+
<h3 class="tsd-anchor-link"><span>attach<wbr/>Handler<wbr/>Instance</span><a href="#attachHandlerInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
390
408
|
<ul class="tsd-signatures">
|
|
391
|
-
<li class="tsd-signature tsd-anchor-link" id="attachHandlerInstance.attachHandlerInstance-1"><span class="tsd-kind-call-signature">attach<wbr/>Handler<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#attachHandlerInstance.attachHandlerInstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
409
|
+
<li class="tsd-signature tsd-anchor-link" id="attachHandlerInstance.attachHandlerInstance-1"><span class="tsd-kind-call-signature">attach<wbr/>Handler<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#attachHandlerInstance.attachHandlerInstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
392
410
|
<li class="tsd-description">
|
|
393
411
|
<div class="tsd-parameters">
|
|
394
412
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -399,27 +417,25 @@ regular <code>'error'</code> listener is installed.</p>
|
|
|
399
417
|
<h5><span class="tsd-kind-parameter">handler</span>: <a href="Handler.html" class="tsd-signature-type tsd-kind-class">Handler</a><span class="tsd-signature-symbol"><</span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a><span class="tsd-signature-symbol">, </span><a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
400
418
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
401
419
|
<ul>
|
|
402
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
420
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L297">src/Application.ts:297</a></li></ul></aside></li></ul></section>
|
|
403
421
|
<section class="tsd-panel tsd-member"><a id="close" class="tsd-anchor"></a>
|
|
404
|
-
<h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
422
|
+
<h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
405
423
|
<ul class="tsd-signatures">
|
|
406
|
-
<li class="tsd-signature tsd-anchor-link" id="close.close-1"><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
424
|
+
<li class="tsd-signature tsd-anchor-link" id="close.close-1"><span class="tsd-kind-call-signature">close</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#close.close-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
407
425
|
<li class="tsd-description">
|
|
408
426
|
<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">
|
|
409
427
|
<ul>
|
|
410
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
428
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L316">src/Application.ts:316</a></li></ul></aside></li></ul></section>
|
|
411
429
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
|
|
412
|
-
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
430
|
+
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
413
431
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
414
|
-
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
432
|
+
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
415
433
|
<li class="tsd-description">
|
|
416
434
|
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
|
417
435
|
to each.</p>
|
|
418
436
|
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
|
419
437
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">myEmitter</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-8">// First listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, </span><span class="hl-0">function</span><span class="hl-3"> </span><span class="hl-5">firstListener</span><span class="hl-3">() {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'Helloooo! first listener'</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><span class="hl-8">// Second listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, </span><span class="hl-0">function</span><span class="hl-3"> </span><span class="hl-5">secondListener</span><span class="hl-3">(</span><span class="hl-4">arg1</span><span class="hl-3">, </span><span class="hl-4">arg2</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">arg1</span><span class="hl-0">}</span><span class="hl-1">, </span><span class="hl-0">${</span><span class="hl-4">arg2</span><span class="hl-0">}</span><span class="hl-1"> in second listener`</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><span class="hl-8">// Third listener</span><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, </span><span class="hl-0">function</span><span class="hl-3"> </span><span class="hl-5">thirdListener</span><span class="hl-3">(...</span><span class="hl-4">args</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">parameters</span><span class="hl-3"> = </span><span class="hl-4">args</span><span class="hl-3">.</span><span class="hl-5">join</span><span class="hl-3">(</span><span class="hl-1">', '</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">`event with parameters </span><span class="hl-0">${</span><span class="hl-4">parameters</span><span class="hl-0">}</span><span class="hl-1"> in third listener`</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><br/><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">listeners</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">));</span><br/><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, </span><span class="hl-2">1</span><span class="hl-3">, </span><span class="hl-2">2</span><span class="hl-3">, </span><span class="hl-2">3</span><span class="hl-3">, </span><span class="hl-2">4</span><span class="hl-3">, </span><span class="hl-2">5</span><span class="hl-3">);</span><br/><br/><span class="hl-8">// Prints:</span><br/><span class="hl-8">// [</span><br/><span class="hl-8">// [Function: firstListener],</span><br/><span class="hl-8">// [Function: secondListener],</span><br/><span class="hl-8">// [Function: thirdListener]</span><br/><span class="hl-8">// ]</span><br/><span class="hl-8">// Helloooo! first listener</span><br/><span class="hl-8">// event with parameters 1, 2 in second listener</span><br/><span class="hl-8">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
|
420
438
|
</code><button>Copy</button></pre>
|
|
421
|
-
|
|
422
|
-
<h3>Since</h3><p>v0.1.26</p>
|
|
423
439
|
</div>
|
|
424
440
|
<div class="tsd-parameters">
|
|
425
441
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -428,134 +444,138 @@ to each.</p>
|
|
|
428
444
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
|
429
445
|
<li>
|
|
430
446
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
431
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
447
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
448
|
+
<div class="tsd-comment tsd-typography">
|
|
449
|
+
<h4>Since</h4><p>v0.1.26</p>
|
|
450
|
+
</div><aside class="tsd-sources">
|
|
432
451
|
<p>Inherited from EventEmitter.emit</p>
|
|
433
452
|
<ul>
|
|
434
453
|
<li>Defined in node_modules/@types/node/events.d.ts:652</li></ul></aside></li></ul></section>
|
|
435
454
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a>
|
|
436
|
-
<h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
455
|
+
<h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
437
456
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
438
|
-
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1"><span class="tsd-kind-call-signature">event<wbr/>Names</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#eventNames.eventNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
457
|
+
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1"><span class="tsd-kind-call-signature">event<wbr/>Names</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#eventNames.eventNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
439
458
|
<li class="tsd-description">
|
|
440
459
|
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
|
441
460
|
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
|
442
461
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">myEE</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> {});</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'bar'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> {});</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">sym</span><span class="hl-3"> = </span><span class="hl-5">Symbol</span><span class="hl-3">(</span><span class="hl-1">'symbol'</span><span class="hl-3">);</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-4">sym</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> {});</span><br/><br/><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">eventNames</span><span class="hl-3">());</span><br/><span class="hl-8">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
|
443
462
|
</code><button>Copy</button></pre>
|
|
444
|
-
|
|
445
|
-
<h3>Since</h3><p>v6.0.0</p>
|
|
446
463
|
</div>
|
|
447
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4
|
|
464
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
465
|
+
<div class="tsd-comment tsd-typography">
|
|
466
|
+
<h4>Since</h4><p>v6.0.0</p>
|
|
467
|
+
</div><aside class="tsd-sources">
|
|
448
468
|
<p>Inherited from EventEmitter.eventNames</p>
|
|
449
469
|
<ul>
|
|
450
470
|
<li>Defined in node_modules/@types/node/events.d.ts:715</li></ul></aside></li></ul></section>
|
|
451
471
|
<section class="tsd-panel tsd-member"><a id="getCmdLineArgs" class="tsd-anchor"></a>
|
|
452
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span><a href="#getCmdLineArgs" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
472
|
+
<h3 class="tsd-anchor-link"><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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
453
473
|
<ul class="tsd-signatures">
|
|
454
|
-
<li class="tsd-signature tsd-anchor-link" id="getCmdLineArgs.getCmdLineArgs-1"><span class="tsd-kind-call-signature">get<wbr/>Cmd<wbr/>Line<wbr/>Args</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><a href="#getCmdLineArgs.getCmdLineArgs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
474
|
+
<li class="tsd-signature tsd-anchor-link" id="getCmdLineArgs.getCmdLineArgs-1"><span class="tsd-kind-call-signature">get<wbr/>Cmd<wbr/>Line<wbr/>Args</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><a href="#getCmdLineArgs.getCmdLineArgs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
455
475
|
<li class="tsd-description">
|
|
456
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
457
476
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h4><p>command line arguments</p>
|
|
458
|
-
|
|
477
|
+
|
|
478
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
459
479
|
<ul>
|
|
460
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
480
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L426">src/Application.ts:426</a></li></ul></aside></li></ul></section>
|
|
461
481
|
<section class="tsd-panel tsd-member"><a id="getConfig" class="tsd-anchor"></a>
|
|
462
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Config</span><a href="#getConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
482
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Config</span><a href="#getConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
463
483
|
<ul class="tsd-signatures">
|
|
464
|
-
<li class="tsd-signature tsd-anchor-link" id="getConfig.getConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><a href="#getConfig.getConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
484
|
+
<li class="tsd-signature tsd-anchor-link" id="getConfig.getConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><a href="#getConfig.getConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
465
485
|
<li class="tsd-description">
|
|
466
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
467
486
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span></h4><p>the config object.</p>
|
|
468
|
-
|
|
487
|
+
|
|
488
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
469
489
|
<ul>
|
|
470
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
490
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L383">src/Application.ts:383</a></li></ul></aside></li></ul></section>
|
|
471
491
|
<section class="tsd-panel tsd-member"><a id="getDB" class="tsd-anchor"></a>
|
|
472
|
-
<h3 class="tsd-anchor-link"><span>getDB</span><a href="#getDB" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
492
|
+
<h3 class="tsd-anchor-link"><span>getDB</span><a href="#getDB" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
473
493
|
<ul class="tsd-signatures">
|
|
474
|
-
<li class="tsd-signature tsd-anchor-link" id="getDB.getDB-1"><span class="tsd-kind-call-signature">getDB</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#getDB.getDB-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
494
|
+
<li class="tsd-signature tsd-anchor-link" id="getDB.getDB-1"><span class="tsd-kind-call-signature">getDB</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#getDB.getDB-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
475
495
|
<li class="tsd-description">
|
|
476
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
477
496
|
<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><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4><p>the database pool. This will need to be casted based on your preferred database dialect.</p>
|
|
478
|
-
|
|
497
|
+
|
|
498
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
479
499
|
<ul>
|
|
480
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
500
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L419">src/Application.ts:419</a></li></ul></aside></li></ul></section>
|
|
481
501
|
<section class="tsd-panel tsd-member"><a id="getLogger" class="tsd-anchor"></a>
|
|
482
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Logger</span><a href="#getLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
502
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Logger</span><a href="#getLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
483
503
|
<ul class="tsd-signatures">
|
|
484
|
-
<li class="tsd-signature tsd-anchor-link" id="getLogger.getLogger-1"><span class="tsd-kind-call-signature">get<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BaseLogger</span><a href="#getLogger.getLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
504
|
+
<li class="tsd-signature tsd-anchor-link" id="getLogger.getLogger-1"><span class="tsd-kind-call-signature">get<wbr/>Logger</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BaseLogger</span><a href="#getLogger.getLogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
485
505
|
<li class="tsd-description">
|
|
486
506
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">BaseLogger</span></h4><aside class="tsd-sources">
|
|
487
507
|
<ul>
|
|
488
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
508
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L240">src/Application.ts:240</a></li></ul></aside></li></ul></section>
|
|
489
509
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a>
|
|
490
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
510
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
491
511
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
492
|
-
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners.getMaxListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getMaxListeners.getMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
512
|
+
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners.getMaxListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getMaxListeners.getMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
493
513
|
<li class="tsd-description">
|
|
494
514
|
<div class="tsd-comment tsd-typography"><p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
|
495
515
|
set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Application.html#defaultMaxListeners" class="tsd-kind-property">defaultMaxListeners</a>.</p>
|
|
496
|
-
|
|
497
|
-
<h3>Since</h3><p>v1.0.0</p>
|
|
498
516
|
</div>
|
|
499
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4
|
|
517
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
518
|
+
<div class="tsd-comment tsd-typography">
|
|
519
|
+
<h4>Since</h4><p>v1.0.0</p>
|
|
520
|
+
</div><aside class="tsd-sources">
|
|
500
521
|
<p>Inherited from EventEmitter.getMaxListeners</p>
|
|
501
522
|
<ul>
|
|
502
523
|
<li>Defined in node_modules/@types/node/events.d.ts:567</li></ul></aside></li></ul></section>
|
|
503
524
|
<section class="tsd-panel tsd-member"><a id="getName" class="tsd-anchor"></a>
|
|
504
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Name</span><a href="#getName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
525
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Name</span><a href="#getName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
505
526
|
<ul class="tsd-signatures">
|
|
506
|
-
<li class="tsd-signature tsd-anchor-link" id="getName.getName-1"><span class="tsd-kind-call-signature">get<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getName.getName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
527
|
+
<li class="tsd-signature tsd-anchor-link" id="getName.getName-1"><span class="tsd-kind-call-signature">get<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getName.getName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
507
528
|
<li class="tsd-description">
|
|
508
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
509
529
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the application name</p>
|
|
510
|
-
|
|
530
|
+
|
|
531
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
511
532
|
<ul>
|
|
512
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
533
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L372">src/Application.ts:372</a></li></ul></aside></li></ul></section>
|
|
513
534
|
<section class="tsd-panel tsd-member"><a id="getPort" class="tsd-anchor"></a>
|
|
514
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Port</span><a href="#getPort" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
535
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Port</span><a href="#getPort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
515
536
|
<ul class="tsd-signatures">
|
|
516
|
-
<li class="tsd-signature tsd-anchor-link" id="getPort.getPort-1"><span class="tsd-kind-call-signature">get<wbr/>Port</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getPort.getPort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
537
|
+
<li class="tsd-signature tsd-anchor-link" id="getPort.getPort-1"><span class="tsd-kind-call-signature">get<wbr/>Port</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getPort.getPort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
517
538
|
<li class="tsd-description">
|
|
518
539
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
519
540
|
<ul>
|
|
520
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
541
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L244">src/Application.ts:244</a></li></ul></aside></li></ul></section>
|
|
521
542
|
<section class="tsd-panel tsd-member"><a id="getProgram" class="tsd-anchor"></a>
|
|
522
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Program</span><a href="#getProgram" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
543
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Program</span><a href="#getProgram" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
523
544
|
<ul class="tsd-signatures">
|
|
524
|
-
<li class="tsd-signature tsd-anchor-link" id="getProgram.getProgram-1"><span class="tsd-kind-call-signature">get<wbr/>Program</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Command</span><a href="#getProgram.getProgram-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
545
|
+
<li class="tsd-signature tsd-anchor-link" id="getProgram.getProgram-1"><span class="tsd-kind-call-signature">get<wbr/>Program</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Command</span><a href="#getProgram.getProgram-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
525
546
|
<li class="tsd-description">
|
|
526
547
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Command</span></h4><aside class="tsd-sources">
|
|
527
548
|
<ul>
|
|
528
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
549
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L275">src/Application.ts:275</a></li></ul></aside></li></ul></section>
|
|
529
550
|
<section class="tsd-panel tsd-member"><a id="getRequestSizeLimit" class="tsd-anchor"></a>
|
|
530
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span><a href="#getRequestSizeLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
551
|
+
<h3 class="tsd-anchor-link"><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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
531
552
|
<ul class="tsd-signatures">
|
|
532
|
-
<li class="tsd-signature tsd-anchor-link" id="getRequestSizeLimit.getRequestSizeLimit-1"><span class="tsd-kind-call-signature">get<wbr/>Request<wbr/>Size<wbr/>Limit</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getRequestSizeLimit.getRequestSizeLimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
553
|
+
<li class="tsd-signature tsd-anchor-link" id="getRequestSizeLimit.getRequestSizeLimit-1"><span class="tsd-kind-call-signature">get<wbr/>Request<wbr/>Size<wbr/>Limit</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getRequestSizeLimit.getRequestSizeLimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
533
554
|
<li class="tsd-description">
|
|
534
555
|
<div class="tsd-comment tsd-typography"><p>The maximum size limit for incoming requests that this service needs to handle.</p>
|
|
535
556
|
</div>
|
|
536
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4
|
|
557
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
558
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
537
559
|
<ul>
|
|
538
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
560
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L282">src/Application.ts:282</a></li></ul></aside></li></ul></section>
|
|
539
561
|
<section class="tsd-panel tsd-member"><a id="getTokenManager" class="tsd-anchor"></a>
|
|
540
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Token<wbr/>Manager</span><a href="#getTokenManager" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
562
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Token<wbr/>Manager</span><a href="#getTokenManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
541
563
|
<ul class="tsd-signatures">
|
|
542
|
-
<li class="tsd-signature tsd-anchor-link" id="getTokenManager.getTokenManager-1"><span class="tsd-kind-call-signature">get<wbr/>Token<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">></span><a href="#getTokenManager.getTokenManager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
564
|
+
<li class="tsd-signature tsd-anchor-link" id="getTokenManager.getTokenManager-1"><span class="tsd-kind-call-signature">get<wbr/>Token<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">></span><a href="#getTokenManager.getTokenManager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
543
565
|
<li class="tsd-description">
|
|
544
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
545
566
|
<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><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">></span></h4><p>the token manager</p>
|
|
546
|
-
|
|
567
|
+
|
|
568
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
547
569
|
<ul>
|
|
548
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
570
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L412">src/Application.ts:412</a></li></ul></aside></li></ul></section>
|
|
549
571
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
|
550
|
-
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
572
|
+
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
551
573
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
552
|
-
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
574
|
+
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
553
575
|
<li class="tsd-description">
|
|
554
576
|
<div class="tsd-comment tsd-typography"><p>Returns the number of listeners listening for the event named <code>eventName</code>.
|
|
555
577
|
If <code>listener</code> is provided, it will return how many times the listener is found
|
|
556
578
|
in the list of the listeners of the event.</p>
|
|
557
|
-
|
|
558
|
-
<h3>Since</h3><p>v3.2.0</p>
|
|
559
579
|
</div>
|
|
560
580
|
<div class="tsd-parameters">
|
|
561
581
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -563,39 +583,45 @@ in the list of the listeners of the event.</p>
|
|
|
563
583
|
<li>
|
|
564
584
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
565
585
|
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
|
566
|
-
</div
|
|
586
|
+
</div>
|
|
587
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
567
588
|
<li>
|
|
568
589
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type ">Function</span></h5>
|
|
569
590
|
<div class="tsd-comment tsd-typography"><p>The event handler function</p>
|
|
570
|
-
</div
|
|
571
|
-
<
|
|
591
|
+
</div>
|
|
592
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
593
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
594
|
+
<div class="tsd-comment tsd-typography">
|
|
595
|
+
<h4>Since</h4><p>v3.2.0</p>
|
|
596
|
+
</div><aside class="tsd-sources">
|
|
572
597
|
<p>Inherited from EventEmitter.listenerCount</p>
|
|
573
598
|
<ul>
|
|
574
599
|
<li>Defined in node_modules/@types/node/events.d.ts:661</li></ul></aside></li></ul></section>
|
|
575
600
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a>
|
|
576
|
-
<h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
601
|
+
<h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
577
602
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
578
|
-
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
603
|
+
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
579
604
|
<li class="tsd-description">
|
|
580
605
|
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
581
606
|
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">, (</span><span class="hl-4">stream</span><span class="hl-3">) </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'someone connected!'</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-4">util</span><span class="hl-3">.</span><span class="hl-5">inspect</span><span class="hl-3">(</span><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">listeners</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">)));</span><br/><span class="hl-8">// Prints: [ [Function] ]</span>
|
|
582
607
|
</code><button>Copy</button></pre>
|
|
583
|
-
|
|
584
|
-
<h3>Since</h3><p>v0.1.26</p>
|
|
585
608
|
</div>
|
|
586
609
|
<div class="tsd-parameters">
|
|
587
610
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
588
611
|
<ul class="tsd-parameter-list">
|
|
589
612
|
<li>
|
|
590
613
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
|
591
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4
|
|
614
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
615
|
+
<div class="tsd-comment tsd-typography">
|
|
616
|
+
<h4>Since</h4><p>v0.1.26</p>
|
|
617
|
+
</div><aside class="tsd-sources">
|
|
592
618
|
<p>Inherited from EventEmitter.listeners</p>
|
|
593
619
|
<ul>
|
|
594
620
|
<li>Defined in node_modules/@types/node/events.d.ts:580</li></ul></aside></li></ul></section>
|
|
595
621
|
<section class="tsd-panel tsd-member"><a id="loadConfig" class="tsd-anchor"></a>
|
|
596
|
-
<h3 class="tsd-anchor-link"><span>load<wbr/>Config</span><a href="#loadConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
622
|
+
<h3 class="tsd-anchor-link"><span>load<wbr/>Config</span><a href="#loadConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
597
623
|
<ul class="tsd-signatures">
|
|
598
|
-
<li class="tsd-signature tsd-anchor-link" id="loadConfig.loadConfig-1"><span class="tsd-kind-call-signature">load<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">></span><a href="#loadConfig.loadConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
624
|
+
<li class="tsd-signature tsd-anchor-link" id="loadConfig.loadConfig-1"><span class="tsd-kind-call-signature">load<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">></span><a href="#loadConfig.loadConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
599
625
|
<li class="tsd-description">
|
|
600
626
|
<div class="tsd-parameters">
|
|
601
627
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -603,18 +629,18 @@ in the list of the listeners of the event.</p>
|
|
|
603
629
|
<li>
|
|
604
630
|
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5>
|
|
605
631
|
<div class="tsd-comment tsd-typography"><p>The directory path that contains bt-config.json and bt-local-config.json</p>
|
|
606
|
-
</div
|
|
607
|
-
<
|
|
632
|
+
</div>
|
|
633
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
634
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">></span></h4>
|
|
635
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
608
636
|
<ul>
|
|
609
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
637
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L352">src/Application.ts:352</a></li></ul></aside></li></ul></section>
|
|
610
638
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
|
|
611
|
-
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
639
|
+
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
612
640
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
613
|
-
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
641
|
+
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
614
642
|
<li class="tsd-description">
|
|
615
643
|
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
|
616
|
-
|
|
617
|
-
<h3>Since</h3><p>v10.0.0</p>
|
|
618
644
|
</div>
|
|
619
645
|
<div class="tsd-parameters">
|
|
620
646
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -634,14 +660,17 @@ in the list of the listeners of the event.</p>
|
|
|
634
660
|
<li>
|
|
635
661
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
636
662
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
637
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
663
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
664
|
+
<div class="tsd-comment tsd-typography">
|
|
665
|
+
<h4>Since</h4><p>v10.0.0</p>
|
|
666
|
+
</div><aside class="tsd-sources">
|
|
638
667
|
<p>Inherited from EventEmitter.off</p>
|
|
639
668
|
<ul>
|
|
640
669
|
<li>Defined in node_modules/@types/node/events.d.ts:540</li></ul></aside></li></ul></section>
|
|
641
670
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a>
|
|
642
|
-
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
671
|
+
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
643
672
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
644
|
-
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
673
|
+
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
645
674
|
<li class="tsd-description">
|
|
646
675
|
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the end of the listeners array for the
|
|
647
676
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
@@ -654,8 +683,6 @@ times.</p>
|
|
|
654
683
|
event listener to the beginning of the listeners array.</p>
|
|
655
684
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">myEE</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'a'</span><span class="hl-3">));</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">prependListener</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'b'</span><span class="hl-3">));</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">);</span><br/><span class="hl-8">// Prints:</span><br/><span class="hl-8">// b</span><br/><span class="hl-8">// a</span>
|
|
656
685
|
</code><button>Copy</button></pre>
|
|
657
|
-
|
|
658
|
-
<h3>Since</h3><p>v0.1.101</p>
|
|
659
686
|
</div>
|
|
660
687
|
<div class="tsd-parameters">
|
|
661
688
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -663,11 +690,13 @@ event listener to the beginning of the listeners array.</p>
|
|
|
663
690
|
<li>
|
|
664
691
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
665
692
|
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
666
|
-
</div
|
|
693
|
+
</div>
|
|
694
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
667
695
|
<li>
|
|
668
696
|
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
|
669
697
|
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
670
698
|
</div>
|
|
699
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
671
700
|
<ul class="tsd-parameters">
|
|
672
701
|
<li class="tsd-parameter-signature">
|
|
673
702
|
<ul class="tsd-signatures tsd-is-external">
|
|
@@ -679,14 +708,17 @@ event listener to the beginning of the listeners array.</p>
|
|
|
679
708
|
<li>
|
|
680
709
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
681
710
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
682
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
711
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
712
|
+
<div class="tsd-comment tsd-typography">
|
|
713
|
+
<h4>Since</h4><p>v0.1.101</p>
|
|
714
|
+
</div><aside class="tsd-sources">
|
|
683
715
|
<p>Inherited from EventEmitter.on</p>
|
|
684
716
|
<ul>
|
|
685
717
|
<li>Defined in node_modules/@types/node/events.d.ts:422</li></ul></aside></li></ul></section>
|
|
686
718
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
|
|
687
|
-
<h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
719
|
+
<h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
688
720
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
689
|
-
<li class="tsd-signature tsd-anchor-link" id="once.once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
721
|
+
<li class="tsd-signature tsd-anchor-link" id="once.once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
690
722
|
<li class="tsd-description">
|
|
691
723
|
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
|
692
724
|
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
|
@@ -697,8 +729,6 @@ next time <code>eventName</code> is triggered, this listener is removed and then
|
|
|
697
729
|
event listener to the beginning of the listeners array.</p>
|
|
698
730
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">myEE</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'a'</span><span class="hl-3">));</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">prependOnceListener</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'b'</span><span class="hl-3">));</span><br/><span class="hl-4">myEE</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">);</span><br/><span class="hl-8">// Prints:</span><br/><span class="hl-8">// b</span><br/><span class="hl-8">// a</span>
|
|
699
731
|
</code><button>Copy</button></pre>
|
|
700
|
-
|
|
701
|
-
<h3>Since</h3><p>v0.3.0</p>
|
|
702
732
|
</div>
|
|
703
733
|
<div class="tsd-parameters">
|
|
704
734
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -706,11 +736,13 @@ event listener to the beginning of the listeners array.</p>
|
|
|
706
736
|
<li>
|
|
707
737
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
708
738
|
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
709
|
-
</div
|
|
739
|
+
</div>
|
|
740
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
710
741
|
<li>
|
|
711
742
|
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
|
712
743
|
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
713
744
|
</div>
|
|
745
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
714
746
|
<ul class="tsd-parameters">
|
|
715
747
|
<li class="tsd-parameter-signature">
|
|
716
748
|
<ul class="tsd-signatures tsd-is-external">
|
|
@@ -722,14 +754,17 @@ event listener to the beginning of the listeners array.</p>
|
|
|
722
754
|
<li>
|
|
723
755
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
724
756
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
725
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
757
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
758
|
+
<div class="tsd-comment tsd-typography">
|
|
759
|
+
<h4>Since</h4><p>v0.3.0</p>
|
|
760
|
+
</div><aside class="tsd-sources">
|
|
726
761
|
<p>Inherited from EventEmitter.once</p>
|
|
727
762
|
<ul>
|
|
728
763
|
<li>Defined in node_modules/@types/node/events.d.ts:452</li></ul></aside></li></ul></section>
|
|
729
764
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a>
|
|
730
|
-
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Listener</span><a href="#prependListener" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
765
|
+
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Listener</span><a href="#prependListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
731
766
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
732
|
-
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#prependListener.prependListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
767
|
+
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#prependListener.prependListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
733
768
|
<li class="tsd-description">
|
|
734
769
|
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
|
735
770
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
@@ -738,8 +773,6 @@ times.</p>
|
|
|
738
773
|
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">prependListener</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">, (</span><span class="hl-4">stream</span><span class="hl-3">) </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'someone connected!'</span><span class="hl-3">);</span><br/><span class="hl-3">});</span>
|
|
739
774
|
</code><button>Copy</button></pre>
|
|
740
775
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
741
|
-
|
|
742
|
-
<h3>Since</h3><p>v6.0.0</p>
|
|
743
776
|
</div>
|
|
744
777
|
<div class="tsd-parameters">
|
|
745
778
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -747,11 +780,13 @@ times.</p>
|
|
|
747
780
|
<li>
|
|
748
781
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
749
782
|
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
750
|
-
</div
|
|
783
|
+
</div>
|
|
784
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
751
785
|
<li>
|
|
752
786
|
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
|
753
787
|
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
754
788
|
</div>
|
|
789
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
755
790
|
<ul class="tsd-parameters">
|
|
756
791
|
<li class="tsd-parameter-signature">
|
|
757
792
|
<ul class="tsd-signatures tsd-is-external">
|
|
@@ -763,22 +798,23 @@ times.</p>
|
|
|
763
798
|
<li>
|
|
764
799
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
765
800
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
766
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
801
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
802
|
+
<div class="tsd-comment tsd-typography">
|
|
803
|
+
<h4>Since</h4><p>v6.0.0</p>
|
|
804
|
+
</div><aside class="tsd-sources">
|
|
767
805
|
<p>Inherited from EventEmitter.prependListener</p>
|
|
768
806
|
<ul>
|
|
769
807
|
<li>Defined in node_modules/@types/node/events.d.ts:679</li></ul></aside></li></ul></section>
|
|
770
808
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a>
|
|
771
|
-
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
809
|
+
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
772
810
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
773
|
-
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#prependOnceListener.prependOnceListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
811
|
+
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#prependOnceListener.prependOnceListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
774
812
|
<li class="tsd-description">
|
|
775
813
|
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the <em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
|
776
814
|
listener is removed, and then invoked.</p>
|
|
777
815
|
<pre><code class="language-js"><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">prependOnceListener</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">, (</span><span class="hl-4">stream</span><span class="hl-3">) </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'Ah, we have our first user!'</span><span class="hl-3">);</span><br/><span class="hl-3">});</span>
|
|
778
816
|
</code><button>Copy</button></pre>
|
|
779
817
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
780
|
-
|
|
781
|
-
<h3>Since</h3><p>v6.0.0</p>
|
|
782
818
|
</div>
|
|
783
819
|
<div class="tsd-parameters">
|
|
784
820
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -786,11 +822,13 @@ listener is removed, and then invoked.</p>
|
|
|
786
822
|
<li>
|
|
787
823
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
788
824
|
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
789
|
-
</div
|
|
825
|
+
</div>
|
|
826
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
790
827
|
<li>
|
|
791
828
|
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
|
792
829
|
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
793
830
|
</div>
|
|
831
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
794
832
|
<ul class="tsd-parameters">
|
|
795
833
|
<li class="tsd-parameter-signature">
|
|
796
834
|
<ul class="tsd-signatures tsd-is-external">
|
|
@@ -802,57 +840,62 @@ listener is removed, and then invoked.</p>
|
|
|
802
840
|
<li>
|
|
803
841
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
804
842
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
805
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
843
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
844
|
+
<div class="tsd-comment tsd-typography">
|
|
845
|
+
<h4>Since</h4><p>v6.0.0</p>
|
|
846
|
+
</div><aside class="tsd-sources">
|
|
806
847
|
<p>Inherited from EventEmitter.prependOnceListener</p>
|
|
807
848
|
<ul>
|
|
808
849
|
<li>Defined in node_modules/@types/node/events.d.ts:695</li></ul></aside></li></ul></section>
|
|
809
850
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
|
|
810
|
-
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
851
|
+
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
811
852
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
812
|
-
<li class="tsd-signature tsd-anchor-link" id="rawListeners.rawListeners-1"><span class="tsd-kind-call-signature">raw<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#rawListeners.rawListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
853
|
+
<li class="tsd-signature tsd-anchor-link" id="rawListeners.rawListeners-1"><span class="tsd-kind-call-signature">raw<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#rawListeners.rawListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
813
854
|
<li class="tsd-description">
|
|
814
855
|
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
|
815
856
|
including any wrappers (such as those created by <code>.once()</code>).</p>
|
|
816
857
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">emitter</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-4">emitter</span><span class="hl-3">.</span><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-1">'log'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'log once'</span><span class="hl-3">));</span><br/><br/><span class="hl-8">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-8">// `listener` which contains the original listener bound above</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">listeners</span><span class="hl-3"> = </span><span class="hl-4">emitter</span><span class="hl-3">.</span><span class="hl-5">rawListeners</span><span class="hl-3">(</span><span class="hl-1">'log'</span><span class="hl-3">);</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">logFnWrapper</span><span class="hl-3"> = </span><span class="hl-4">listeners</span><span class="hl-3">[</span><span class="hl-2">0</span><span class="hl-3">];</span><br/><br/><span class="hl-8">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-3">.</span><span class="hl-5">listener</span><span class="hl-3">();</span><br/><br/><span class="hl-8">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-5">logFnWrapper</span><span class="hl-3">();</span><br/><br/><span class="hl-4">emitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'log'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'log persistently'</span><span class="hl-3">));</span><br/><span class="hl-8">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">newListeners</span><span class="hl-3"> = </span><span class="hl-4">emitter</span><span class="hl-3">.</span><span class="hl-5">rawListeners</span><span class="hl-3">(</span><span class="hl-1">'log'</span><span class="hl-3">);</span><br/><br/><span class="hl-8">// Logs "log persistently" twice</span><br/><span class="hl-4">newListeners</span><span class="hl-3">[</span><span class="hl-2">0</span><span class="hl-3">]();</span><br/><span class="hl-4">emitter</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'log'</span><span class="hl-3">);</span>
|
|
817
858
|
</code><button>Copy</button></pre>
|
|
818
|
-
|
|
819
|
-
<h3>Since</h3><p>v9.4.0</p>
|
|
820
859
|
</div>
|
|
821
860
|
<div class="tsd-parameters">
|
|
822
861
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
823
862
|
<ul class="tsd-parameter-list">
|
|
824
863
|
<li>
|
|
825
864
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
|
826
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4
|
|
865
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
866
|
+
<div class="tsd-comment tsd-typography">
|
|
867
|
+
<h4>Since</h4><p>v9.4.0</p>
|
|
868
|
+
</div><aside class="tsd-sources">
|
|
827
869
|
<p>Inherited from EventEmitter.rawListeners</p>
|
|
828
870
|
<ul>
|
|
829
871
|
<li>Defined in node_modules/@types/node/events.d.ts:611</li></ul></aside></li></ul></section>
|
|
830
872
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
|
|
831
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
873
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
832
874
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
833
|
-
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1"><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
875
|
+
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1"><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
834
876
|
<li class="tsd-description">
|
|
835
877
|
<div class="tsd-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
|
836
878
|
<p>It is bad practice to remove listeners added elsewhere in the code,
|
|
837
879
|
particularly when the <code>EventEmitter</code> instance was created by some other
|
|
838
880
|
component or module (e.g. sockets or file streams).</p>
|
|
839
881
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
840
|
-
|
|
841
|
-
<h3>Since</h3><p>v0.1.26</p>
|
|
842
882
|
</div>
|
|
843
883
|
<div class="tsd-parameters">
|
|
844
884
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
845
885
|
<ul class="tsd-parameter-list">
|
|
846
886
|
<li>
|
|
847
887
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
|
848
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
888
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
889
|
+
<div class="tsd-comment tsd-typography">
|
|
890
|
+
<h4>Since</h4><p>v0.1.26</p>
|
|
891
|
+
</div><aside class="tsd-sources">
|
|
849
892
|
<p>Inherited from EventEmitter.removeAllListeners</p>
|
|
850
893
|
<ul>
|
|
851
894
|
<li>Defined in node_modules/@types/node/events.d.ts:551</li></ul></aside></li></ul></section>
|
|
852
895
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a>
|
|
853
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
896
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
854
897
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
855
|
-
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
898
|
+
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
856
899
|
<li class="tsd-description">
|
|
857
900
|
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
|
858
901
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-5">callback</span><span class="hl-3"> = (</span><span class="hl-4">stream</span><span class="hl-3">) </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'someone connected!'</span><span class="hl-3">);</span><br/><span class="hl-3">};</span><br/><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">, </span><span class="hl-4">callback</span><span class="hl-3">);</span><br/><span class="hl-8">// ...</span><br/><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">removeListener</span><span class="hl-3">(</span><span class="hl-1">'connection'</span><span class="hl-3">, </span><span class="hl-4">callback</span><span class="hl-3">);</span>
|
|
@@ -877,8 +920,6 @@ recently added instance. In the example the <code>once('ping')</code>lis
|
|
|
877
920
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ee</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-0">function</span><span class="hl-3"> </span><span class="hl-5">pong</span><span class="hl-3">() {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'pong'</span><span class="hl-3">);</span><br/><span class="hl-3">}</span><br/><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'ping'</span><span class="hl-3">, </span><span class="hl-4">pong</span><span class="hl-3">);</span><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-1">'ping'</span><span class="hl-3">, </span><span class="hl-4">pong</span><span class="hl-3">);</span><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">removeListener</span><span class="hl-3">(</span><span class="hl-1">'ping'</span><span class="hl-3">, </span><span class="hl-4">pong</span><span class="hl-3">);</span><br/><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'ping'</span><span class="hl-3">);</span><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'ping'</span><span class="hl-3">);</span>
|
|
878
921
|
</code><button>Copy</button></pre>
|
|
879
922
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
880
|
-
|
|
881
|
-
<h3>Since</h3><p>v0.1.26</p>
|
|
882
923
|
</div>
|
|
883
924
|
<div class="tsd-parameters">
|
|
884
925
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -898,36 +939,40 @@ recently added instance. In the example the <code>once('ping')</code>lis
|
|
|
898
939
|
<li>
|
|
899
940
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
900
941
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
|
901
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
942
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
943
|
+
<div class="tsd-comment tsd-typography">
|
|
944
|
+
<h4>Since</h4><p>v0.1.26</p>
|
|
945
|
+
</div><aside class="tsd-sources">
|
|
902
946
|
<p>Inherited from EventEmitter.removeListener</p>
|
|
903
947
|
<ul>
|
|
904
948
|
<li>Defined in node_modules/@types/node/events.d.ts:535</li></ul></aside></li></ul></section>
|
|
905
949
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a>
|
|
906
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
950
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
907
951
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
908
|
-
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners.setMaxListeners-1"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#setMaxListeners.setMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
952
|
+
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners.setMaxListeners-1"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span><a href="#setMaxListeners.setMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
909
953
|
<li class="tsd-description">
|
|
910
954
|
<div class="tsd-comment tsd-typography"><p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
|
|
911
955
|
added for a particular event. This is a useful default that helps finding
|
|
912
956
|
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
|
913
957
|
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
|
914
958
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
915
|
-
|
|
916
|
-
<h3>Since</h3><p>v0.3.5</p>
|
|
917
959
|
</div>
|
|
918
960
|
<div class="tsd-parameters">
|
|
919
961
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
920
962
|
<ul class="tsd-parameter-list">
|
|
921
963
|
<li>
|
|
922
964
|
<h5><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
|
923
|
-
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4
|
|
965
|
+
<h4 class="tsd-returns-title">Returns <a href="Application.html" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConfig</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TDBConnectionAPI</span><span class="tsd-signature-symbol">></span></h4>
|
|
966
|
+
<div class="tsd-comment tsd-typography">
|
|
967
|
+
<h4>Since</h4><p>v0.3.5</p>
|
|
968
|
+
</div><aside class="tsd-sources">
|
|
924
969
|
<p>Inherited from EventEmitter.setMaxListeners</p>
|
|
925
970
|
<ul>
|
|
926
971
|
<li>Defined in node_modules/@types/node/events.d.ts:561</li></ul></aside></li></ul></section>
|
|
927
972
|
<section class="tsd-panel tsd-member"><a id="setTokenManager" class="tsd-anchor"></a>
|
|
928
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Token<wbr/>Manager</span><a href="#setTokenManager" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
973
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Token<wbr/>Manager</span><a href="#setTokenManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
929
974
|
<ul class="tsd-signatures">
|
|
930
|
-
<li class="tsd-signature tsd-anchor-link" id="setTokenManager.setTokenManager-1"><span class="tsd-kind-call-signature">set<wbr/>Token<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tokenManager</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTokenManager.setTokenManager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
975
|
+
<li class="tsd-signature tsd-anchor-link" id="setTokenManager.setTokenManager-1"><span class="tsd-kind-call-signature">set<wbr/>Token<wbr/>Manager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tokenManager</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTokenManager.setTokenManager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
931
976
|
<li class="tsd-description">
|
|
932
977
|
<div class="tsd-comment tsd-typography"><p>Sets the TokenManager to be used for authentication.</p>
|
|
933
978
|
</div>
|
|
@@ -935,32 +980,34 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|
|
935
980
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
936
981
|
<ul class="tsd-parameter-list">
|
|
937
982
|
<li>
|
|
938
|
-
<h5><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><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">></span></h5
|
|
939
|
-
<
|
|
983
|
+
<h5><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><span class="tsd-signature-type tsd-kind-type-parameter">TAuthToken</span><span class="tsd-signature-symbol">></span></h5>
|
|
984
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
985
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
986
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
940
987
|
<ul>
|
|
941
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
988
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L405">src/Application.ts:405</a></li></ul></aside></li></ul></section>
|
|
942
989
|
<section class="tsd-panel tsd-member"><a id="shouldListen" class="tsd-anchor"></a>
|
|
943
|
-
<h3 class="tsd-anchor-link"><span>should<wbr/>Listen</span><a href="#shouldListen" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
990
|
+
<h3 class="tsd-anchor-link"><span>should<wbr/>Listen</span><a href="#shouldListen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
944
991
|
<ul class="tsd-signatures">
|
|
945
|
-
<li class="tsd-signature tsd-anchor-link" id="shouldListen.shouldListen-1"><span class="tsd-kind-call-signature">should<wbr/>Listen</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#shouldListen.shouldListen-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
992
|
+
<li class="tsd-signature tsd-anchor-link" id="shouldListen.shouldListen-1"><span class="tsd-kind-call-signature">should<wbr/>Listen</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#shouldListen.shouldListen-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
946
993
|
<li class="tsd-description">
|
|
947
|
-
<div class="tsd-comment tsd-typography"></div>
|
|
948
994
|
<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>
|
|
949
|
-
|
|
995
|
+
|
|
996
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
950
997
|
<ul>
|
|
951
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
998
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L390">src/Application.ts:390</a></li></ul></aside></li></ul></section>
|
|
952
999
|
<section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a>
|
|
953
|
-
<h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1000
|
+
<h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
954
1001
|
<ul class="tsd-signatures">
|
|
955
|
-
<li class="tsd-signature tsd-anchor-link" id="start.start-1"><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1002
|
+
<li class="tsd-signature tsd-anchor-link" id="start.start-1"><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
956
1003
|
<li class="tsd-description">
|
|
957
1004
|
<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">
|
|
958
1005
|
<ul>
|
|
959
|
-
<li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
1006
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/04df9d1/src/Application.ts#L91">src/Application.ts:91</a></li></ul></aside></li></ul></section>
|
|
960
1007
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a>
|
|
961
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1008
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
962
1009
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
963
|
-
<li class="tsd-signature tsd-anchor-link" id="getEventListeners.getEventListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Event<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#getEventListeners.getEventListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1010
|
+
<li class="tsd-signature tsd-anchor-link" id="getEventListeners.getEventListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Event<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#getEventListeners.getEventListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
964
1011
|
<li class="tsd-description">
|
|
965
1012
|
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
966
1013
|
<p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.listeners</code> on
|
|
@@ -969,8 +1016,6 @@ the emitter.</p>
|
|
|
969
1016
|
event target. This is useful for debugging and diagnostic purposes.</p>
|
|
970
1017
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">getEventListeners</span><span class="hl-3">, </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><br/><span class="hl-3">{</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ee</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-5">listener</span><span class="hl-3"> = () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'Events are fun'</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-4">listener</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-5">getEventListeners</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'foo'</span><span class="hl-3">)); </span><span class="hl-8">// [ [Function: listener] ]</span><br/><span class="hl-3">}</span><br/><span class="hl-3">{</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">et</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventTarget</span><span class="hl-3">();</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-5">listener</span><span class="hl-3"> = () </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'Events are fun'</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">et</span><span class="hl-3">.</span><span class="hl-5">addEventListener</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-4">listener</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-5">getEventListeners</span><span class="hl-3">(</span><span class="hl-4">et</span><span class="hl-3">, </span><span class="hl-1">'foo'</span><span class="hl-3">)); </span><span class="hl-8">// [ [Function: listener] ]</span><br/><span class="hl-3">}</span>
|
|
971
1018
|
</code><button>Copy</button></pre>
|
|
972
|
-
|
|
973
|
-
<h3>Since</h3><p>v15.2.0, v14.17.0</p>
|
|
974
1019
|
</div>
|
|
975
1020
|
<div class="tsd-parameters">
|
|
976
1021
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -979,22 +1024,21 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
|
|
979
1024
|
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">_DOMEventTarget</span></h5></li>
|
|
980
1025
|
<li>
|
|
981
1026
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
|
982
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4
|
|
1027
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
1028
|
+
<div class="tsd-comment tsd-typography">
|
|
1029
|
+
<h4>Since</h4><p>v15.2.0, v14.17.0</p>
|
|
1030
|
+
</div><aside class="tsd-sources">
|
|
983
1031
|
<p>Inherited from EventEmitter.getEventListeners</p>
|
|
984
1032
|
<ul>
|
|
985
1033
|
<li>Defined in node_modules/@types/node/events.d.ts:296</li></ul></aside></li></ul></section>
|
|
986
1034
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount-2" class="tsd-anchor"></a>
|
|
987
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>listener<wbr/>Count</span><a href="#listenerCount-2" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1035
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>listener<wbr/>Count</span><a href="#listenerCount-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
988
1036
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
989
|
-
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1037
|
+
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
990
1038
|
<li class="tsd-description">
|
|
991
1039
|
<div class="tsd-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
|
992
1040
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3">, </span><span class="hl-4">listenerCount</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">myEmitter</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> {});</span><br/><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, () </span><span class="hl-0">=></span><span class="hl-3"> {});</span><br/><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-5">listenerCount</span><span class="hl-3">(</span><span class="hl-4">myEmitter</span><span class="hl-3">, </span><span class="hl-1">'event'</span><span class="hl-3">));</span><br/><span class="hl-8">// Prints: 2</span>
|
|
993
1041
|
</code><button>Copy</button></pre>
|
|
994
|
-
|
|
995
|
-
<h3>Since</h3><p>v0.9.12</p>
|
|
996
|
-
|
|
997
|
-
<h3>Deprecated</h3><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
|
|
998
1042
|
</div>
|
|
999
1043
|
<div class="tsd-parameters">
|
|
1000
1044
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1002,19 +1046,26 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
|
|
1002
1046
|
<li>
|
|
1003
1047
|
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span></h5>
|
|
1004
1048
|
<div class="tsd-comment tsd-typography"><p>The emitter to query</p>
|
|
1005
|
-
</div
|
|
1049
|
+
</div>
|
|
1050
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1006
1051
|
<li>
|
|
1007
1052
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
|
1008
1053
|
<div class="tsd-comment tsd-typography"><p>The event name</p>
|
|
1009
|
-
</div
|
|
1010
|
-
<
|
|
1054
|
+
</div>
|
|
1055
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1056
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
1057
|
+
<div class="tsd-comment tsd-typography">
|
|
1058
|
+
<h4>Since</h4><p>v0.9.12</p>
|
|
1059
|
+
|
|
1060
|
+
<h4>Deprecated</h4><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
|
|
1061
|
+
</div><aside class="tsd-sources">
|
|
1011
1062
|
<p>Inherited from EventEmitter.listenerCount</p>
|
|
1012
1063
|
<ul>
|
|
1013
1064
|
<li>Defined in node_modules/@types/node/events.d.ts:268</li></ul></aside></li></ul></section>
|
|
1014
1065
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on-2" class="tsd-anchor"></a>
|
|
1015
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>on</span><a href="#on-2" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1066
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>on</span><a href="#on-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1016
1067
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1017
|
-
<li class="tsd-signature tsd-anchor-link" id="on-2.on-3"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-2.on-3" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1068
|
+
<li class="tsd-signature tsd-anchor-link" id="on-2.on-3"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-2.on-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1018
1069
|
<li class="tsd-description">
|
|
1019
1070
|
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">on</span><span class="hl-3">, </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-6">import</span><span class="hl-3"> </span><span class="hl-4">process</span><span class="hl-3"> </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:process'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ee</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-8">// Emit later on</span><br/><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-5">nextTick</span><span class="hl-3">(() </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-1">'bar'</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-2">42</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><br/><span class="hl-6">for</span><span class="hl-3"> </span><span class="hl-6">await</span><span class="hl-3"> (</span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">event</span><span class="hl-3"> </span><span class="hl-0">of</span><span class="hl-3"> </span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'foo'</span><span class="hl-3">)) {</span><br/><span class="hl-3"> </span><span class="hl-8">// The execution of this inner block is synchronous and it</span><br/><span class="hl-3"> </span><span class="hl-8">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-3"> </span><span class="hl-8">// if concurrent execution is required.</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-4">event</span><span class="hl-3">); </span><span class="hl-8">// prints ['bar'] [42]</span><br/><span class="hl-3">}</span><br/><span class="hl-8">// Unreachable here</span>
|
|
1020
1071
|
</code><button>Copy</button></pre>
|
|
@@ -1025,8 +1076,6 @@ composed of the emitted event arguments.</p>
|
|
|
1025
1076
|
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
|
1026
1077
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">on</span><span class="hl-3">, </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><span class="hl-6">import</span><span class="hl-3"> </span><span class="hl-4">process</span><span class="hl-3"> </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:process'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ac</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">AbortController</span><span class="hl-3">();</span><br/><br/><span class="hl-3">(</span><span class="hl-0">async</span><span class="hl-3"> () </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ee</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-3"> </span><span class="hl-8">// Emit later on</span><br/><span class="hl-3"> </span><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-5">nextTick</span><span class="hl-3">(() </span><span class="hl-0">=></span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-1">'bar'</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-2">42</span><span class="hl-3">);</span><br/><span class="hl-3"> });</span><br/><br/><span class="hl-3"> </span><span class="hl-6">for</span><span class="hl-3"> </span><span class="hl-6">await</span><span class="hl-3"> (</span><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">event</span><span class="hl-3"> </span><span class="hl-0">of</span><span class="hl-3"> </span><span class="hl-5">on</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'foo'</span><span class="hl-3">, { </span><span class="hl-4">signal:</span><span class="hl-3"> </span><span class="hl-4">ac</span><span class="hl-3">.</span><span class="hl-4">signal</span><span class="hl-3"> })) {</span><br/><span class="hl-3"> </span><span class="hl-8">// The execution of this inner block is synchronous and it</span><br/><span class="hl-3"> </span><span class="hl-8">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-3"> </span><span class="hl-8">// if concurrent execution is required.</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-4">event</span><span class="hl-3">); </span><span class="hl-8">// prints ['bar'] [42]</span><br/><span class="hl-3"> }</span><br/><span class="hl-3"> </span><span class="hl-8">// Unreachable here</span><br/><span class="hl-3">})();</span><br/><br/><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-5">nextTick</span><span class="hl-3">(() </span><span class="hl-0">=></span><span class="hl-3"> </span><span class="hl-4">ac</span><span class="hl-3">.</span><span class="hl-5">abort</span><span class="hl-3">());</span>
|
|
1027
1078
|
</code><button>Copy</button></pre>
|
|
1028
|
-
|
|
1029
|
-
<h3>Since</h3><p>v13.6.0, v12.16.0</p>
|
|
1030
1079
|
</div>
|
|
1031
1080
|
<div class="tsd-parameters">
|
|
1032
1081
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1036,18 +1085,22 @@ composed of the emitted event arguments.</p>
|
|
|
1036
1085
|
<li>
|
|
1037
1086
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1038
1087
|
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
|
1039
|
-
</div
|
|
1088
|
+
</div>
|
|
1089
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1040
1090
|
<li>
|
|
1041
1091
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
|
1042
1092
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
|
|
1043
|
-
|
|
1093
|
+
|
|
1094
|
+
<div class="tsd-comment tsd-typography">
|
|
1095
|
+
<h4>Since</h4><p>v13.6.0, v12.16.0</p>
|
|
1096
|
+
</div><aside class="tsd-sources">
|
|
1044
1097
|
<p>Inherited from EventEmitter.on</p>
|
|
1045
1098
|
<ul>
|
|
1046
1099
|
<li>Defined in node_modules/@types/node/events.d.ts:250</li></ul></aside></li></ul></section>
|
|
1047
1100
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once-2" class="tsd-anchor"></a>
|
|
1048
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>once</span><a href="#once-2" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1101
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>once</span><a href="#once-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1049
1102
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1050
|
-
<li class="tsd-signature tsd-anchor-link" id="once-2.once-3"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-3" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1103
|
+
<li class="tsd-signature tsd-anchor-link" id="once-2.once-3"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1051
1104
|
<li class="tsd-description">
|
|
1052
1105
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
|
|
1053
1106
|
event or that is rejected if the <code>EventEmitter</code> emits <code>'error'</code> while waiting.
|
|
@@ -1065,8 +1118,6 @@ special handling:</p>
|
|
|
1065
1118
|
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
|
1066
1119
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">EventEmitter</span><span class="hl-3">, </span><span class="hl-4">once</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ee</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">ac</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">AbortController</span><span class="hl-3">();</span><br/><br/><span class="hl-0">async</span><span class="hl-3"> </span><span class="hl-0">function</span><span class="hl-3"> </span><span class="hl-5">foo</span><span class="hl-3">(</span><span class="hl-4">emitter</span><span class="hl-3">, </span><span class="hl-4">event</span><span class="hl-3">, </span><span class="hl-4">signal</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-6">try</span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-4">emitter</span><span class="hl-3">, </span><span class="hl-4">event</span><span class="hl-3">, { </span><span class="hl-4">signal</span><span class="hl-3"> });</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'event emitted!'</span><span class="hl-3">);</span><br/><span class="hl-3"> } </span><span class="hl-6">catch</span><span class="hl-3"> (</span><span class="hl-4">error</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-6">if</span><span class="hl-3"> (</span><span class="hl-4">error</span><span class="hl-3">.</span><span class="hl-4">name</span><span class="hl-3"> === </span><span class="hl-1">'AbortError'</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">error</span><span class="hl-3">(</span><span class="hl-1">'Waiting for the event was canceled!'</span><span class="hl-3">);</span><br/><span class="hl-3"> } </span><span class="hl-6">else</span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">error</span><span class="hl-3">(</span><span class="hl-1">'There was an error'</span><span class="hl-3">, </span><span class="hl-4">error</span><span class="hl-3">.</span><span class="hl-4">message</span><span class="hl-3">);</span><br/><span class="hl-3"> }</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">}</span><br/><br/><span class="hl-5">foo</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'foo'</span><span class="hl-3">, </span><span class="hl-4">ac</span><span class="hl-3">.</span><span class="hl-4">signal</span><span class="hl-3">);</span><br/><span class="hl-4">ac</span><span class="hl-3">.</span><span class="hl-5">abort</span><span class="hl-3">(); </span><span class="hl-8">// Abort waiting for the event</span><br/><span class="hl-4">ee</span><span class="hl-3">.</span><span class="hl-5">emit</span><span class="hl-3">(</span><span class="hl-1">'foo'</span><span class="hl-3">); </span><span class="hl-8">// Prints: Waiting for the event was canceled!</span>
|
|
1067
1120
|
</code><button>Copy</button></pre>
|
|
1068
|
-
|
|
1069
|
-
<h3>Since</h3><p>v11.13.0, v10.16.0</p>
|
|
1070
1121
|
</div>
|
|
1071
1122
|
<div class="tsd-parameters">
|
|
1072
1123
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1077,11 +1128,14 @@ special handling:</p>
|
|
|
1077
1128
|
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
|
1078
1129
|
<li>
|
|
1079
1130
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
|
1080
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4
|
|
1131
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
1132
|
+
<div class="tsd-comment tsd-typography">
|
|
1133
|
+
<h4>Since</h4><p>v11.13.0, v10.16.0</p>
|
|
1134
|
+
</div><aside class="tsd-sources">
|
|
1081
1135
|
<p>Inherited from EventEmitter.once</p>
|
|
1082
1136
|
<ul>
|
|
1083
1137
|
<li>Defined in node_modules/@types/node/events.d.ts:189</li></ul></aside></li>
|
|
1084
|
-
<li class="tsd-signature tsd-anchor-link" id="once-2.once-4"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-4" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1138
|
+
<li class="tsd-signature tsd-anchor-link" id="once-2.once-4"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1085
1139
|
<li class="tsd-description">
|
|
1086
1140
|
<div class="tsd-parameters">
|
|
1087
1141
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1097,14 +1151,12 @@ special handling:</p>
|
|
|
1097
1151
|
<ul>
|
|
1098
1152
|
<li>Defined in node_modules/@types/node/events.d.ts:190</li></ul></aside></li></ul></section>
|
|
1099
1153
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners-2" class="tsd-anchor"></a>
|
|
1100
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners-2" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1154
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1101
1155
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1102
|
-
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners-2.setMaxListeners-3"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMaxListeners-2.setMaxListeners-3" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1156
|
+
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners-2.setMaxListeners-3"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMaxListeners-2.setMaxListeners-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1103
1157
|
<li class="tsd-description">
|
|
1104
1158
|
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">setMaxListeners</span><span class="hl-3">, </span><span class="hl-4">EventEmitter</span><span class="hl-3"> } </span><span class="hl-6">from</span><span class="hl-3"> </span><span class="hl-1">'node:events'</span><span class="hl-3">;</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">target</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventTarget</span><span class="hl-3">();</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">emitter</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">EventEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-5">setMaxListeners</span><span class="hl-3">(</span><span class="hl-2">5</span><span class="hl-3">, </span><span class="hl-4">target</span><span class="hl-3">, </span><span class="hl-4">emitter</span><span class="hl-3">);</span>
|
|
1105
1159
|
</code><button>Copy</button></pre>
|
|
1106
|
-
|
|
1107
|
-
<h3>Since</h3><p>v15.4.0</p>
|
|
1108
1160
|
</div>
|
|
1109
1161
|
<div class="tsd-parameters">
|
|
1110
1162
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1112,10 +1164,14 @@ special handling:</p>
|
|
|
1112
1164
|
<li>
|
|
1113
1165
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1114
1166
|
<div class="tsd-comment tsd-typography"><p>A non-negative number. The maximum number of listeners per <code>EventTarget</code> event.</p>
|
|
1115
|
-
</div
|
|
1167
|
+
</div>
|
|
1168
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1116
1169
|
<li>
|
|
1117
1170
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">_DOMEventTarget</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
1118
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
1171
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1172
|
+
<div class="tsd-comment tsd-typography">
|
|
1173
|
+
<h4>Since</h4><p>v15.4.0</p>
|
|
1174
|
+
</div><aside class="tsd-sources">
|
|
1119
1175
|
<p>Inherited from EventEmitter.setMaxListeners</p>
|
|
1120
1176
|
<ul>
|
|
1121
1177
|
<li>Defined in node_modules/@types/node/events.d.ts:311</li></ul></aside></li></ul></section></section></div>
|
|
@@ -1123,7 +1179,7 @@ special handling:</p>
|
|
|
1123
1179
|
<div class="page-menu">
|
|
1124
1180
|
<div class="tsd-navigation settings">
|
|
1125
1181
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1126
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
1182
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
1127
1183
|
<div class="tsd-accordion-details">
|
|
1128
1184
|
<div class="tsd-filter-visibility">
|
|
1129
1185
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -1134,160 +1190,141 @@ special handling:</p>
|
|
|
1134
1190
|
<div class="tsd-theme-toggle">
|
|
1135
1191
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1136
1192
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1137
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
1193
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1138
1194
|
<div class="tsd-accordion-details">
|
|
1139
1195
|
<ul>
|
|
1140
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon"
|
|
1141
|
-
<li><a href="#captureRejectionSymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1142
|
-
<li><a href="#captureRejections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1143
|
-
<li><a href="#defaultMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1144
|
-
<li><a href="#errorMonitor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1145
|
-
<li><a href="#_attachHandlers" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1146
|
-
<li><a href="#_buildArgOptions" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1147
|
-
<li><a href="#_closeDatabase" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1148
|
-
<li><a href="#_closeSocket" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1149
|
-
<li><a href="#_createLogger" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1150
|
-
<li><a href="#_initDB" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1151
|
-
<li><a href="#_initLogger" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1152
|
-
<li><a href="#_initialize" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1153
|
-
<li><a href="#_onBeforeReadyAsync" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1154
|
-
<li><a href="#_onConfigLoad" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1155
|
-
<li><a href="#_onReady" class="tsd-is-protected"><svg class="tsd-kind-icon"
|
|
1156
|
-
<li><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1157
|
-
<li><a href="#attachHandler" class=""><svg class="tsd-kind-icon"
|
|
1158
|
-
<li><a href="#attachHandlerInstance" class=""><svg class="tsd-kind-icon"
|
|
1159
|
-
<li><a href="#close" class=""><svg class="tsd-kind-icon"
|
|
1160
|
-
<li><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1161
|
-
<li><a href="#eventNames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1162
|
-
<li><a href="#getCmdLineArgs" class=""><svg class="tsd-kind-icon"
|
|
1163
|
-
<li><a href="#getConfig" class=""><svg class="tsd-kind-icon"
|
|
1164
|
-
<li><a href="#getDB" class=""><svg class="tsd-kind-icon"
|
|
1165
|
-
<li><a href="#getLogger" class=""><svg class="tsd-kind-icon"
|
|
1166
|
-
<li><a href="#getMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1167
|
-
<li><a href="#getName" class=""><svg class="tsd-kind-icon"
|
|
1168
|
-
<li><a href="#getPort" class=""><svg class="tsd-kind-icon"
|
|
1169
|
-
<li><a href="#getProgram" class=""><svg class="tsd-kind-icon"
|
|
1170
|
-
<li><a href="#getRequestSizeLimit" class=""><svg class="tsd-kind-icon"
|
|
1171
|
-
<li><a href="#getTokenManager" class=""><svg class="tsd-kind-icon"
|
|
1172
|
-
<li><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1173
|
-
<li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1174
|
-
<li><a href="#loadConfig" class=""><svg class="tsd-kind-icon"
|
|
1175
|
-
<li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1176
|
-
<li><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1177
|
-
<li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1178
|
-
<li><a href="#prependListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1179
|
-
<li><a href="#prependOnceListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1180
|
-
<li><a href="#rawListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1181
|
-
<li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1182
|
-
<li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1183
|
-
<li><a href="#setMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1184
|
-
<li><a href="#setTokenManager" class=""><svg class="tsd-kind-icon"
|
|
1185
|
-
<li><a href="#shouldListen" class=""><svg class="tsd-kind-icon"
|
|
1186
|
-
<li><a href="#start" class=""><svg class="tsd-kind-icon"
|
|
1187
|
-
<li><a href="#getEventListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1188
|
-
<li><a href="#listenerCount-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1189
|
-
<li><a href="#on-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1190
|
-
<li><a href="#once-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1191
|
-
<li><a href="#setMaxListeners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1196
|
+
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
1197
|
+
<li><a href="#captureRejectionSymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a></li>
|
|
1198
|
+
<li><a href="#captureRejections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejections</span></a></li>
|
|
1199
|
+
<li><a href="#defaultMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a></li>
|
|
1200
|
+
<li><a href="#errorMonitor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error<wbr/>Monitor</span></a></li>
|
|
1201
|
+
<li><a href="#_attachHandlers" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_attach<wbr/>Handlers</span></a></li>
|
|
1202
|
+
<li><a href="#_buildArgOptions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_build<wbr/>Arg<wbr/>Options</span></a></li>
|
|
1203
|
+
<li><a href="#_closeDatabase" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_close<wbr/>Database</span></a></li>
|
|
1204
|
+
<li><a href="#_closeSocket" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_close<wbr/>Socket</span></a></li>
|
|
1205
|
+
<li><a href="#_createLogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_create<wbr/>Logger</span></a></li>
|
|
1206
|
+
<li><a href="#_initDB" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_initDB</span></a></li>
|
|
1207
|
+
<li><a href="#_initLogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_init<wbr/>Logger</span></a></li>
|
|
1208
|
+
<li><a href="#_initialize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_initialize</span></a></li>
|
|
1209
|
+
<li><a href="#_onBeforeReadyAsync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Before<wbr/>Ready<wbr/>Async</span></a></li>
|
|
1210
|
+
<li><a href="#_onConfigLoad" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Config<wbr/>Load</span></a></li>
|
|
1211
|
+
<li><a href="#_onReady" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_on<wbr/>Ready</span></a></li>
|
|
1212
|
+
<li><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a></li>
|
|
1213
|
+
<li><a href="#attachHandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>attach<wbr/>Handler</span></a></li>
|
|
1214
|
+
<li><a href="#attachHandlerInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>attach<wbr/>Handler<wbr/>Instance</span></a></li>
|
|
1215
|
+
<li><a href="#close" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>close</span></a></li>
|
|
1216
|
+
<li><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a></li>
|
|
1217
|
+
<li><a href="#eventNames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a></li>
|
|
1218
|
+
<li><a href="#getCmdLineArgs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span></a></li>
|
|
1219
|
+
<li><a href="#getConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Config</span></a></li>
|
|
1220
|
+
<li><a href="#getDB" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getDB</span></a></li>
|
|
1221
|
+
<li><a href="#getLogger" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Logger</span></a></li>
|
|
1222
|
+
<li><a href="#getMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a></li>
|
|
1223
|
+
<li><a href="#getName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Name</span></a></li>
|
|
1224
|
+
<li><a href="#getPort" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Port</span></a></li>
|
|
1225
|
+
<li><a href="#getProgram" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Program</span></a></li>
|
|
1226
|
+
<li><a href="#getRequestSizeLimit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span></a></li>
|
|
1227
|
+
<li><a href="#getTokenManager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Manager</span></a></li>
|
|
1228
|
+
<li><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a></li>
|
|
1229
|
+
<li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a></li>
|
|
1230
|
+
<li><a href="#loadConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load<wbr/>Config</span></a></li>
|
|
1231
|
+
<li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
|
|
1232
|
+
<li><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
|
1233
|
+
<li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li>
|
|
1234
|
+
<li><a href="#prependListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a></li>
|
|
1235
|
+
<li><a href="#prependOnceListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a></li>
|
|
1236
|
+
<li><a href="#rawListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a></li>
|
|
1237
|
+
<li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a></li>
|
|
1238
|
+
<li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a></li>
|
|
1239
|
+
<li><a href="#setMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a></li>
|
|
1240
|
+
<li><a href="#setTokenManager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Token<wbr/>Manager</span></a></li>
|
|
1241
|
+
<li><a href="#shouldListen" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>should<wbr/>Listen</span></a></li>
|
|
1242
|
+
<li><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a></li>
|
|
1243
|
+
<li><a href="#getEventListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Listeners</span></a></li>
|
|
1244
|
+
<li><a href="#listenerCount-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a></li>
|
|
1245
|
+
<li><a href="#on-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
|
1246
|
+
<li><a href="#once-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li>
|
|
1247
|
+
<li><a href="#setMaxListeners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a></li></ul></div></details></div>
|
|
1192
1248
|
<div class="site-menu">
|
|
1193
|
-
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon"
|
|
1249
|
+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@breautek/storm</span></a>
|
|
1194
1250
|
<ul class="tsd-small-nested-navigation">
|
|
1195
|
-
<li>
|
|
1196
|
-
<
|
|
1197
|
-
<
|
|
1198
|
-
<
|
|
1199
|
-
<li><a href="../
|
|
1200
|
-
<li><a href="../
|
|
1201
|
-
<li><a href="../
|
|
1202
|
-
<li><a href="
|
|
1203
|
-
<li><a href="
|
|
1204
|
-
<li><a href="
|
|
1205
|
-
<li><a href="
|
|
1206
|
-
<li><a href="
|
|
1207
|
-
<li><a href="
|
|
1208
|
-
<li><a href="
|
|
1209
|
-
<li><a href="
|
|
1210
|
-
<li><a href="
|
|
1211
|
-
<li><a href="
|
|
1212
|
-
<li><a href="
|
|
1213
|
-
<li><a href="
|
|
1214
|
-
<li><a href="
|
|
1215
|
-
<li><a href="
|
|
1216
|
-
<li><a href="
|
|
1217
|
-
<li><a href="
|
|
1218
|
-
<li><a href="
|
|
1219
|
-
<li><a href="
|
|
1220
|
-
<li><a href="
|
|
1221
|
-
<li><a href="
|
|
1222
|
-
<li><a href="
|
|
1223
|
-
<li><a href="
|
|
1224
|
-
<li><a href="
|
|
1225
|
-
<li><a href="
|
|
1226
|
-
<li><a href="
|
|
1227
|
-
<li><a href="
|
|
1228
|
-
<li><a href="
|
|
1229
|
-
<li><a href="
|
|
1230
|
-
<li><a href="
|
|
1231
|
-
<li><a href="
|
|
1232
|
-
<li><a href="
|
|
1233
|
-
<li><a href="
|
|
1234
|
-
<li><a href="
|
|
1235
|
-
<li><a href="
|
|
1236
|
-
<li><a href="
|
|
1237
|
-
<li><a href="
|
|
1238
|
-
<li><a href="
|
|
1239
|
-
<li><a href="
|
|
1240
|
-
<li><a href="
|
|
1241
|
-
<li><a href="
|
|
1242
|
-
<li><a href="
|
|
1243
|
-
<li><a href="
|
|
1244
|
-
<li><a href="
|
|
1245
|
-
<li><a href="
|
|
1246
|
-
<li><a href="
|
|
1247
|
-
<li><a href="
|
|
1248
|
-
<li><a href="
|
|
1249
|
-
<li><a href="
|
|
1250
|
-
<li><a href="
|
|
1251
|
-
<li><a href="
|
|
1252
|
-
<li><a href="
|
|
1253
|
-
<li><a href="
|
|
1254
|
-
<li><a href="
|
|
1255
|
-
<li><a href="
|
|
1256
|
-
<li><a href="
|
|
1257
|
-
<li><a href="
|
|
1258
|
-
<li><a href="
|
|
1259
|
-
<li><a href="
|
|
1260
|
-
<li><a href="
|
|
1261
|
-
<li><a href="
|
|
1262
|
-
<li><a href="
|
|
1263
|
-
<li><a href="
|
|
1264
|
-
<li><a href="
|
|
1265
|
-
<li><a href="../interfaces/
|
|
1266
|
-
<li><a href="../
|
|
1267
|
-
<li><a href="../
|
|
1268
|
-
<li><a href="../
|
|
1269
|
-
<li><a href="../
|
|
1270
|
-
<li><a href="../
|
|
1271
|
-
<li><a href="../
|
|
1272
|
-
<li><a href="../interfaces/IDatabaseConnection.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IDatabase<wbr/>Connection</span></a></li>
|
|
1273
|
-
<li><a href="../interfaces/IErrorResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IError<wbr/>Response</span></a></li>
|
|
1274
|
-
<li><a href="../interfaces/IFormData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IForm<wbr/>Data</span></a></li>
|
|
1275
|
-
<li><a href="../interfaces/IHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IHandler</span></a></li>
|
|
1276
|
-
<li><a href="../interfaces/IInsertQueryResult.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IInsert<wbr/>Query<wbr/>Result</span></a></li>
|
|
1277
|
-
<li><a href="../interfaces/IJWTVerifyOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IJWTVerify<wbr/>Options</span></a></li>
|
|
1278
|
-
<li><a href="../interfaces/IParameterMap.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IParameter<wbr/>Map</span></a></li>
|
|
1279
|
-
<li><a href="../interfaces/IQueryable.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IQueryable</span></a></li>
|
|
1280
|
-
<li><a href="../interfaces/IRequestResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IRequest<wbr/>Response</span></a></li>
|
|
1281
|
-
<li><a href="../interfaces/IServiceHeaders.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IService<wbr/>Headers</span></a></li>
|
|
1282
|
-
<li><a href="../interfaces/ISetSessionVariableQueryInput.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>ISet<wbr/>Session<wbr/>Variable<wbr/>Query<wbr/>Input</span></a></li>
|
|
1283
|
-
<li><a href="../interfaces/ITemporaryTableQueryInput.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>ITemporary<wbr/>Table<wbr/>Query<wbr/>Input</span></a></li>
|
|
1284
|
-
<li><a href="../interfaces/IUpdateQueryResult.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IUpdate<wbr/>Query<wbr/>Result</span></a></li>
|
|
1285
|
-
<li><a href="../types/IDeleteQueryResult.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>IDelete<wbr/>Query<wbr/>Result</span></a></li>
|
|
1286
|
-
<li><a href="../types/IHandlerError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>IHandler<wbr/>Error</span></a></li>
|
|
1287
|
-
<li><a href="../types/IHandlerResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>IHandler<wbr/>Response</span></a></li>
|
|
1288
|
-
<li><a href="../types/TCoordinate.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>TCoordinate</span></a></li>
|
|
1289
|
-
<li><a href="../functions/formidable-1.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>formidable</span></a></li>
|
|
1290
|
-
<li><a href="../functions/getInstance.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance</span></a></li></ul></nav></div></div></div>
|
|
1251
|
+
<li><a href="../modules/formidable.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>formidable</span></a></li>
|
|
1252
|
+
<li><a href="../enums/ErrorCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>Error<wbr/>Code</span></a></li>
|
|
1253
|
+
<li><a href="../enums/ExitCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Exit<wbr/>Code</span></a></li>
|
|
1254
|
+
<li><a href="../enums/HTTPMethod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>HTTPMethod</span></a></li>
|
|
1255
|
+
<li><a href="../enums/IsolationLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Isolation<wbr/>Level</span></a></li>
|
|
1256
|
+
<li><a href="../enums/JWTError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>JWTError</span></a></li>
|
|
1257
|
+
<li><a href="../enums/StatusCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Status<wbr/>Code</span></a></li>
|
|
1258
|
+
<li><a href="Application.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Application</span></a></li>
|
|
1259
|
+
<li><a href="BackendAuthenticationMiddleware.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Backend<wbr/>Authentication<wbr/>Middleware</span></a></li>
|
|
1260
|
+
<li><a href="CORSMiddleware.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>CORSMiddleware</span></a></li>
|
|
1261
|
+
<li><a href="ConfigLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Config<wbr/>Loader</span></a></li>
|
|
1262
|
+
<li><a href="Database.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Database</span></a></li>
|
|
1263
|
+
<li><a href="DatabaseCastObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Database<wbr/>Cast<wbr/>Object</span></a></li>
|
|
1264
|
+
<li><a href="DatabaseConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Database<wbr/>Connection</span></a></li>
|
|
1265
|
+
<li><a href="DatabaseQueryError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Database<wbr/>Query<wbr/>Error</span></a></li>
|
|
1266
|
+
<li><a href="DeadLockError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dead<wbr/>Lock<wbr/>Error</span></a></li>
|
|
1267
|
+
<li><a href="DiskSpaceError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Disk<wbr/>Space<wbr/>Error</span></a></li>
|
|
1268
|
+
<li><a href="DropTemporaryTableQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Drop<wbr/>Temporary<wbr/>Table<wbr/>Query</span></a></li>
|
|
1269
|
+
<li><a href="DuplicateEntryError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Duplicate<wbr/>Entry<wbr/>Error</span></a></li>
|
|
1270
|
+
<li><a href="EntityNotFoundError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Entity<wbr/>Not<wbr/>Found<wbr/>Error</span></a></li>
|
|
1271
|
+
<li><a href="ExpiredTokenError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Expired<wbr/>Token<wbr/>Error</span></a></li>
|
|
1272
|
+
<li><a href="Handler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Handler</span></a></li>
|
|
1273
|
+
<li><a href="InternalError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Internal<wbr/>Error</span></a></li>
|
|
1274
|
+
<li><a href="InvalidCredentialsError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Invalid<wbr/>Credentials<wbr/>Error</span></a></li>
|
|
1275
|
+
<li><a href="InvalidValueError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Invalid<wbr/>Value<wbr/>Error</span></a></li>
|
|
1276
|
+
<li><a href="LineString.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Line<wbr/>String</span></a></li>
|
|
1277
|
+
<li><a href="LockWaitTimeoutError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lock<wbr/>Wait<wbr/>Timeout<wbr/>Error</span></a></li>
|
|
1278
|
+
<li><a href="ManagedDatabaseConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Managed<wbr/>Database<wbr/>Connection</span></a></li>
|
|
1279
|
+
<li><a href="Middleware.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Middleware</span></a></li>
|
|
1280
|
+
<li><a href="MissingConfigError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Missing<wbr/>Config<wbr/>Error</span></a></li>
|
|
1281
|
+
<li><a href="MissingParameterError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Missing<wbr/>Parameter<wbr/>Error</span></a></li>
|
|
1282
|
+
<li><a href="MySQLConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MySQLConnection</span></a></li>
|
|
1283
|
+
<li><a href="MySQLDatabase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>MySQLDatabase</span></a></li>
|
|
1284
|
+
<li><a href="NotImplementedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Not<wbr/>Implemented<wbr/>Error</span></a></li>
|
|
1285
|
+
<li><a href="Point.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Point</span></a></li>
|
|
1286
|
+
<li><a href="Polygon.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Polygon</span></a></li>
|
|
1287
|
+
<li><a href="Query.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Query</span></a></li>
|
|
1288
|
+
<li><a href="RawError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Raw<wbr/>Error</span></a></li>
|
|
1289
|
+
<li><a href="RawQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Raw<wbr/>Query</span></a></li>
|
|
1290
|
+
<li><a href="Request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Request</span></a></li>
|
|
1291
|
+
<li><a href="Response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Response</span></a></li>
|
|
1292
|
+
<li><a href="ResponseData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Response<wbr/>Data</span></a></li>
|
|
1293
|
+
<li><a href="ServiceProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Service<wbr/>Provider</span></a></li>
|
|
1294
|
+
<li><a href="ServiceResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Service<wbr/>Response</span></a></li>
|
|
1295
|
+
<li><a href="SetSessionVariableQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Set<wbr/>Session<wbr/>Variable<wbr/>Query</span></a></li>
|
|
1296
|
+
<li><a href="StormError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Storm<wbr/>Error</span></a></li>
|
|
1297
|
+
<li><a href="TemporaryTableQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Temporary<wbr/>Table<wbr/>Query</span></a></li>
|
|
1298
|
+
<li><a href="Token.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Token</span></a></li>
|
|
1299
|
+
<li><a href="TokenManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Token<wbr/>Manager</span></a></li>
|
|
1300
|
+
<li><a href="Transaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Transaction</span></a></li>
|
|
1301
|
+
<li><a href="UnauthorizedAccessError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unauthorized<wbr/>Access<wbr/>Error</span></a></li>
|
|
1302
|
+
<li><a href="../interfaces/IAdditionalErrorDetails.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>IAdditional<wbr/>Error<wbr/>Details</span></a></li>
|
|
1303
|
+
<li><a href="../interfaces/IAuthTokenData.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IAuth<wbr/>Token<wbr/>Data</span></a></li>
|
|
1304
|
+
<li><a href="../interfaces/ICloudwatchConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICloudwatch<wbr/>Config</span></a></li>
|
|
1305
|
+
<li><a href="../interfaces/ICloudwatchCredentials.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICloudwatch<wbr/>Credentials</span></a></li>
|
|
1306
|
+
<li><a href="../interfaces/ICloudwatchStreamConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICloudwatch<wbr/>Stream<wbr/>Config</span></a></li>
|
|
1307
|
+
<li><a href="../interfaces/IConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IConfig</span></a></li>
|
|
1308
|
+
<li><a href="../interfaces/IDatabaseConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IDatabase<wbr/>Config</span></a></li>
|
|
1309
|
+
<li><a href="../interfaces/IDatabaseConnection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IDatabase<wbr/>Connection</span></a></li>
|
|
1310
|
+
<li><a href="../interfaces/IErrorResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IError<wbr/>Response</span></a></li>
|
|
1311
|
+
<li><a href="../interfaces/IFormData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IForm<wbr/>Data</span></a></li>
|
|
1312
|
+
<li><a href="../interfaces/IHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IHandler</span></a></li>
|
|
1313
|
+
<li><a href="../interfaces/IInsertQueryResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IInsert<wbr/>Query<wbr/>Result</span></a></li>
|
|
1314
|
+
<li><a href="../interfaces/IJWTVerifyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJWTVerify<wbr/>Options</span></a></li>
|
|
1315
|
+
<li><a href="../interfaces/IParameterMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IParameter<wbr/>Map</span></a></li>
|
|
1316
|
+
<li><a href="../interfaces/IQueryable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IQueryable</span></a></li>
|
|
1317
|
+
<li><a href="../interfaces/IRequestResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IRequest<wbr/>Response</span></a></li>
|
|
1318
|
+
<li><a href="../interfaces/IServiceHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IService<wbr/>Headers</span></a></li>
|
|
1319
|
+
<li><a href="../interfaces/ISetSessionVariableQueryInput.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ISet<wbr/>Session<wbr/>Variable<wbr/>Query<wbr/>Input</span></a></li>
|
|
1320
|
+
<li><a href="../interfaces/ITemporaryTableQueryInput.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ITemporary<wbr/>Table<wbr/>Query<wbr/>Input</span></a></li>
|
|
1321
|
+
<li><a href="../interfaces/IUpdateQueryResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IUpdate<wbr/>Query<wbr/>Result</span></a></li>
|
|
1322
|
+
<li><a href="../types/IDeleteQueryResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>IDelete<wbr/>Query<wbr/>Result</span></a></li>
|
|
1323
|
+
<li><a href="../types/IHandlerError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IHandler<wbr/>Error</span></a></li>
|
|
1324
|
+
<li><a href="../types/IHandlerResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IHandler<wbr/>Response</span></a></li>
|
|
1325
|
+
<li><a href="../types/TCoordinate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>TCoordinate</span></a></li>
|
|
1326
|
+
<li><a href="../functions/formidable-1.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>formidable</span></a></li>
|
|
1327
|
+
<li><a href="../functions/getInstance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Instance</span></a></li></ul></nav></div></div></div>
|
|
1291
1328
|
<div class="tsd-generator">
|
|
1292
1329
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1293
1330
|
<div class="overlay"></div></body></html>
|