@breautek/storm 9.7.3 → 9.7.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 +15 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/highlight.css +5 -5
- package/docs/assets/main.js +1 -1
- package/docs/assets/style.css +18 -3
- package/docs/classes/Application.html +927 -254
- package/docs/classes/Command.html +1470 -147
- package/docs/classes/ConfigLoader.html +110 -4
- package/docs/classes/Database.html +220 -3
- package/docs/classes/DatabaseCastObject.html +104 -3
- package/docs/classes/DatabaseConnection.html +484 -50
- package/docs/classes/DatabaseQueryError.html +264 -13
- package/docs/classes/DeadLockError.html +265 -14
- package/docs/classes/DiskSpaceError.html +245 -11
- package/docs/classes/DropTemporaryTableQuery.html +199 -12
- package/docs/classes/DuplicateEntryError.html +247 -11
- package/docs/classes/EntityNotFoundError.html +245 -11
- package/docs/classes/ExpiredTokenError.html +245 -11
- package/docs/classes/ForbiddenError.html +241 -11
- package/docs/classes/GetMySQLVersion.html +203 -12
- package/docs/classes/Handler.html +283 -3
- package/docs/classes/IllegalStateError.html +250 -12
- package/docs/classes/InternalError.html +245 -11
- package/docs/classes/InvalidCredentialsError.html +245 -11
- package/docs/classes/InvalidValueError.html +247 -11
- package/docs/classes/LineString.html +112 -3
- package/docs/classes/LockWaitTimeoutError.html +265 -14
- package/docs/classes/ManagedDatabaseConnection.html +349 -6
- package/docs/classes/MetricStore.html +119 -2
- package/docs/classes/Middleware.html +122 -3
- package/docs/classes/MissingConfigError.html +245 -11
- package/docs/classes/MissingParameterError.html +245 -11
- package/docs/classes/MySQLConnection.html +509 -54
- package/docs/classes/MySQLDatabase.html +235 -3
- package/docs/classes/NotImplementedError.html +245 -11
- package/docs/classes/Point.html +113 -3
- package/docs/classes/Polygon.html +112 -3
- package/docs/classes/Query.html +220 -12
- package/docs/classes/RawError.html +249 -12
- package/docs/classes/RawQuery.html +212 -12
- package/docs/classes/Request.html +345 -8
- package/docs/classes/Response.html +204 -3
- package/docs/classes/ResponseData.html +162 -5
- package/docs/classes/ServiceProvider.html +243 -3
- package/docs/classes/ServiceResponse.html +108 -3
- package/docs/classes/SetSessionVariableQuery.html +199 -12
- package/docs/classes/StormError.html +261 -11
- package/docs/classes/TemporaryTableQuery.html +203 -12
- package/docs/classes/TimeoutError.html +246 -12
- package/docs/classes/Token.html +80 -3
- package/docs/classes/TokenManager.html +137 -5
- package/docs/classes/Transaction.html +163 -4
- package/docs/classes/UnauthorizedAccessError.html +245 -11
- package/docs/enums/ErrorCode.html +94 -2
- package/docs/enums/ExitCode.html +59 -2
- package/docs/enums/HTTPMethod.html +69 -2
- package/docs/enums/IsolationLevel.html +69 -2
- package/docs/enums/JWTError.html +59 -2
- package/docs/enums/StatusCode.html +289 -2
- package/docs/enums/TransactionAccessLevel.html +64 -3
- package/docs/functions/getInstance.html +42 -2
- package/docs/hierarchy.html +83 -1
- package/docs/index.html +59 -1
- package/docs/interfaces/IAdditionalErrorDetails.html +37 -1
- package/docs/interfaces/IAuthTokenData.html +65 -2
- package/docs/interfaces/ICloudwatchConfig.html +65 -2
- package/docs/interfaces/ICloudwatchCredentials.html +60 -2
- package/docs/interfaces/ICloudwatchStreamConfig.html +60 -2
- package/docs/interfaces/IConfig.html +114 -3
- package/docs/interfaces/IDatabaseConfig.html +84 -2
- package/docs/interfaces/IDatabaseConnection.html +270 -5
- package/docs/interfaces/IDatabasePosition.html +65 -3
- package/docs/interfaces/IErrorResponse.html +75 -2
- package/docs/interfaces/IFormData.html +60 -2
- package/docs/interfaces/IGetMySQLVersionResult.html +70 -2
- package/docs/interfaces/IGetMySQLVersionRow.html +55 -2
- package/docs/interfaces/IHistogramConfig.html +79 -2
- package/docs/interfaces/IInsertQueryResult.html +65 -2
- package/docs/interfaces/IJWTVerifyOptions.html +55 -2
- package/docs/interfaces/IMetricConfig.html +71 -2
- package/docs/interfaces/IMetricCounter.html +74 -2
- package/docs/interfaces/IMetricGauge.html +122 -2
- package/docs/interfaces/IMetricHistogram.html +87 -2
- package/docs/interfaces/IOKPacket.html +95 -3
- package/docs/interfaces/IParameterMap.html +37 -1
- package/docs/interfaces/IQueryable.html +134 -2
- package/docs/interfaces/IRequestResponse.html +65 -2
- package/docs/interfaces/ISetSessionVariableQueryInput.html +60 -2
- package/docs/interfaces/IStormCLIArgs.html +85 -2
- package/docs/interfaces/ITemporaryTableQueryInput.html +60 -2
- package/docs/interfaces/IUpdateQueryResult.html +60 -2
- package/docs/interfaces/formidable.EmitData.html +71 -2
- package/docs/interfaces/formidable.EventData.html +86 -2
- package/docs/interfaces/formidable.File.html +138 -12
- package/docs/interfaces/formidable.FileJSON.html +120 -9
- package/docs/interfaces/formidable.Options.html +226 -32
- package/docs/interfaces/formidable.Part.html +534 -64
- package/docs/modules/formidable.html +41 -1
- package/docs/types/IDeleteQueryResult.html +33 -1
- package/docs/types/IStoredProcedureResult.html +44 -3
- package/docs/types/TCoordinate.html +33 -1
- package/docs/types/TExpiresIn.html +33 -1
- package/docs/types/TSerializableResponse.html +41 -4
- package/docs/types/TSupportedResponsePrimitives.html +33 -1
- package/docs/types/TSupportedResponseTypes.html +33 -1
- package/docs/types/formidable.BufferEncoding.html +34 -1
- package/docs/types/formidable.DefaultOptions.html +34 -1
- package/docs/types/formidable.EnabledPlugins.html +34 -1
- package/docs/types/formidable.EventNames.html +64 -8
- package/docs/types/formidable.Fields.html +38 -1
- package/docs/types/formidable.Files.html +38 -1
- package/docs/types/formidable.FormidableError.html +34 -1
- package/docs/types/formidable.MappedParsers.html +34 -1
- package/docs/types/formidable.Plugin.html +34 -1
- package/docs/types/formidable.PluginFunction.html +47 -1
- package/docs/types/formidable.Plugins.html +34 -1
- package/docs/variables/formidable.html +81 -1
- package/lib/Application.js +1 -0
- package/lib/Application.js.map +1 -1
- package/lib/MySQLConnection.js +2 -2
- package/package.json +11 -11
- package/pnpm-workspace.yaml +3 -1
- package/src/Application.ts +1 -0
- package/src/MySQLConnection.ts +2 -2
|
@@ -1,10 +1,45 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Application | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
<
|
|
5
|
-
<
|
|
6
|
-
<a href="#
|
|
7
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Application | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@breautek/storm</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">Application</a></li></ul>
|
|
12
|
+
<h1>Class Application<TConfig, TAuthToken, TDBConfig, TDBConnectionAPI><code class="tsd-tag">Abstract</code></h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Main entry point for the Application. Should be extended and have the abstract methods implemented.</p>
|
|
15
|
+
</div></section>
|
|
16
|
+
<section class="tsd-panel">
|
|
17
|
+
<h4>Type Parameters</h4>
|
|
18
|
+
<ul class="tsd-type-parameter-list">
|
|
19
|
+
<li><span id="tconfig"><span class="tsd-kind-type-parameter">TConfig</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a> = <a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a></span></li>
|
|
20
|
+
<li><span id="tauthtoken"><span class="tsd-kind-type-parameter">TAuthToken</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a> = <a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a></span></li>
|
|
21
|
+
<li><span id="tdbconfig"><span class="tsd-kind-type-parameter">TDBConfig</span> = <span class="tsd-signature-type">any</span></span></li>
|
|
22
|
+
<li><span id="tdbconnectionapi"><span class="tsd-kind-type-parameter">TDBConnectionAPI</span> = <span class="tsd-signature-type">any</span></span></li></ul></section>
|
|
23
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="3">
|
|
24
|
+
<h4>Hierarchy</h4>
|
|
25
|
+
<ul class="tsd-hierarchy">
|
|
26
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">EventEmitter</span>
|
|
27
|
+
<ul class="tsd-hierarchy">
|
|
28
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Application</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
29
|
+
<ul>
|
|
30
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L59">src/Application.ts:59</a></li></ul></aside>
|
|
31
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
32
|
+
<section class="tsd-panel tsd-index-panel">
|
|
33
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
34
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
35
|
+
<div class="tsd-accordion-details">
|
|
36
|
+
<section class="tsd-index-section">
|
|
37
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
38
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
39
|
+
</div></section>
|
|
40
|
+
<section class="tsd-index-section">
|
|
41
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
|
+
<div class="tsd-index-list"><a href="#_attachhandlers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>attach<wbr/>Handlers</span></a>
|
|
8
43
|
<a href="#_buildargoptions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>build<wbr/>Arg<wbr/>Options</span></a>
|
|
9
44
|
<a href="#_closedatabase" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Database</span></a>
|
|
10
45
|
<a href="#_closesocket" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Socket</span></a>
|
|
@@ -16,7 +51,7 @@
|
|
|
16
51
|
<a href="#_onbeforereadyasync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Before<wbr/>Ready<wbr/>Async</span></a>
|
|
17
52
|
<a href="#_onconfigload" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Config<wbr/>Load</span></a>
|
|
18
53
|
<a href="#_onready" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Ready</span></a>
|
|
19
|
-
<a href="#capturerejectionsymbol
|
|
54
|
+
<a href="#capturerejectionsymbol" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]?</span></a>
|
|
20
55
|
<a href="#addlistener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
|
21
56
|
<a href="#attachhandler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler</span></a>
|
|
22
57
|
<a href="#attachhandlerinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler<wbr/>Instance</span></a>
|
|
@@ -55,163 +90,829 @@
|
|
|
55
90
|
<a href="#settokenmanager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Token<wbr/>Manager</span></a>
|
|
56
91
|
<a href="#shouldlisten" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Listen</span></a>
|
|
57
92
|
<a href="#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
|
|
58
|
-
|
|
59
|
-
<
|
|
60
|
-
<
|
|
61
|
-
<
|
|
62
|
-
<
|
|
63
|
-
<
|
|
64
|
-
<
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
<
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
<
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
<
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
<
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
<
|
|
86
|
-
|
|
87
|
-
<
|
|
93
|
+
</div></section></div></details></section></section>
|
|
94
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
95
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
96
|
+
<section>
|
|
97
|
+
<section class="tsd-panel tsd-member">
|
|
98
|
+
<h3 class="tsd-anchor-link" id="constructor"><span class="deprecated">constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
99
|
+
<ul class="tsd-signatures">
|
|
100
|
+
<li class="">
|
|
101
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorapplication"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Application</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorapplicationtconfig">TConfig</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</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><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorapplicationtauthtoken">TAuthToken</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</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><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorapplicationtdbconfig">TDBConfig</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorapplicationtdbconnectionapi">TDBConnectionAPI</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">configPath</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span><a href="#constructorapplication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
102
|
+
<div class="tsd-description">
|
|
103
|
+
<section class="tsd-panel">
|
|
104
|
+
<h4>Type Parameters</h4>
|
|
105
|
+
<ul class="tsd-type-parameter-list">
|
|
106
|
+
<li><span id="constructorapplicationtconfig"><span class="tsd-kind-type-parameter">TConfig</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a> = <a href="../interfaces/IConfig.html" class="tsd-signature-type tsd-kind-interface">IConfig</a></span></li>
|
|
107
|
+
<li><span id="constructorapplicationtauthtoken"><span class="tsd-kind-type-parameter">TAuthToken</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a> = <a href="../interfaces/IAuthTokenData.html" class="tsd-signature-type tsd-kind-interface">IAuthTokenData</a></span></li>
|
|
108
|
+
<li><span id="constructorapplicationtdbconfig"><span class="tsd-kind-type-parameter">TDBConfig</span> = <span class="tsd-signature-type">any</span></span></li>
|
|
109
|
+
<li><span id="constructorapplicationtdbconnectionapi"><span class="tsd-kind-type-parameter">TDBConnectionAPI</span> = <span class="tsd-signature-type">any</span></span></li></ul></section>
|
|
110
|
+
<div class="tsd-parameters">
|
|
111
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
112
|
+
<ul class="tsd-parameter-list">
|
|
113
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
114
|
+
<div class="tsd-comment tsd-typography"><p>The application name</p>
|
|
115
|
+
</div></li>
|
|
116
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">configPath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
117
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Application</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span></h4>
|
|
118
|
+
<div class="tsd-comment tsd-typography">
|
|
119
|
+
<div class="tsd-tag-deprecated">
|
|
120
|
+
<h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The directory where bt-config.json and bt-local-config.json can be found. Defaults to current working directory.</p>
|
|
121
|
+
</div></div><aside class="tsd-sources">
|
|
122
|
+
<p>Overrides EventEmitter.constructor</p>
|
|
123
|
+
<ul>
|
|
124
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L103">src/Application.ts:103</a></li></ul></aside></div></li></ul></section></section></details>
|
|
125
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
126
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
127
|
+
<section>
|
|
128
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
129
|
+
<h3 class="tsd-anchor-link" id="_attachhandlers"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Abstract</code><span>_<wbr/>attach<wbr/>Handlers</span><a href="#_attachhandlers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
130
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
131
|
+
<li class="">
|
|
132
|
+
<div class="tsd-signature tsd-anchor-link" id="_attachhandlers-1"><span class="tsd-kind-call-signature">_attachHandlers</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
133
|
+
<div class="tsd-description">
|
|
134
|
+
<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>
|
|
135
|
+
</div>
|
|
136
|
+
<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>
|
|
137
|
+
<aside class="tsd-sources">
|
|
138
|
+
<ul>
|
|
139
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L458">src/Application.ts:458</a></li></ul></aside></div></li></ul></section>
|
|
140
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
141
|
+
<h3 class="tsd-anchor-link" id="_buildargoptions"><code class="tsd-tag">Protected</code><span>_<wbr/>build<wbr/>Arg<wbr/>Options</span><a href="#_buildargoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
142
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
143
|
+
<li class="">
|
|
144
|
+
<div class="tsd-signature tsd-anchor-link" id="_buildargoptions-1"><span class="tsd-kind-call-signature">_buildArgOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">program</span><span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#_buildargoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
145
|
+
<div class="tsd-description">
|
|
146
|
+
<div class="tsd-parameters">
|
|
147
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
148
|
+
<ul class="tsd-parameter-list">
|
|
149
|
+
<li><span><span class="tsd-kind-parameter">program</span>: <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div>
|
|
150
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
151
|
+
<ul>
|
|
152
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L377">src/Application.ts:377</a></li></ul></aside></div></li></ul></section>
|
|
153
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
154
|
+
<h3 class="tsd-anchor-link" id="_closedatabase"><code class="tsd-tag">Protected</code><span>_<wbr/>close<wbr/>Database</span><a href="#_closedatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
155
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
156
|
+
<li class="">
|
|
157
|
+
<div class="tsd-signature tsd-anchor-link" id="_closedatabase-1"><span class="tsd-kind-call-signature">_closeDatabase</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
158
|
+
<div class="tsd-description">
|
|
159
|
+
<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">
|
|
160
|
+
<ul>
|
|
161
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L435">src/Application.ts:435</a></li></ul></aside></div></li></ul></section>
|
|
162
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
163
|
+
<h3 class="tsd-anchor-link" id="_closesocket"><code class="tsd-tag">Protected</code><span>_<wbr/>close<wbr/>Socket</span><a href="#_closesocket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
164
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
165
|
+
<li class="">
|
|
166
|
+
<div class="tsd-signature tsd-anchor-link" id="_closesocket-1"><span class="tsd-kind-call-signature">_closeSocket</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
167
|
+
<div class="tsd-description">
|
|
168
|
+
<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">
|
|
169
|
+
<ul>
|
|
170
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L441">src/Application.ts:441</a></li></ul></aside></div></li></ul></section>
|
|
171
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
172
|
+
<h3 class="tsd-anchor-link" id="_createlogger"><code class="tsd-tag">Protected</code><span>_<wbr/>create<wbr/>Logger</span><a href="#_createlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
173
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
174
|
+
<li class="">
|
|
175
|
+
<div class="tsd-signature tsd-anchor-link" id="_createlogger-1"><span class="tsd-kind-call-signature">_createLogger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BaseLogger</span><a href="#_createlogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
176
|
+
<div class="tsd-description">
|
|
177
|
+
<div class="tsd-parameters">
|
|
178
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
179
|
+
<ul class="tsd-parameter-list">
|
|
180
|
+
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
181
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BaseLogger</span></h4><aside class="tsd-sources">
|
|
182
|
+
<ul>
|
|
183
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L252">src/Application.ts:252</a></li></ul></aside></div></li></ul></section>
|
|
184
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
185
|
+
<h3 class="tsd-anchor-link" id="_getversion"><code class="tsd-tag">Protected</code><span>_<wbr/>get<wbr/>Version</span><a href="#_getversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
186
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
187
|
+
<li class="">
|
|
188
|
+
<div class="tsd-signature tsd-anchor-link" id="_getversion-1"><span class="tsd-kind-call-signature">_getVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#_getversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
189
|
+
<div class="tsd-description">
|
|
190
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
191
|
+
<ul>
|
|
192
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L340">src/Application.ts:340</a></li></ul></aside></div></li></ul></section>
|
|
193
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
194
|
+
<h3 class="tsd-anchor-link" id="_initdb"><code class="tsd-tag">Protected</code><span>_<wbr/>init<wbr/>DB</span><a href="#_initdb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
195
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
196
|
+
<li class="">
|
|
197
|
+
<div class="tsd-signature tsd-anchor-link" id="_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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><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><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#_initdb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
198
|
+
<div class="tsd-description">
|
|
199
|
+
<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>
|
|
200
|
+
</div>
|
|
201
|
+
<div class="tsd-parameters">
|
|
202
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
203
|
+
<ul class="tsd-parameter-list">
|
|
204
|
+
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span>
|
|
205
|
+
<div class="tsd-comment tsd-typography"><p>The bt-config object</p>
|
|
206
|
+
</div></li></ul></div>
|
|
207
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Database.html" class="tsd-signature-type tsd-kind-class">Database</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
208
|
+
<ul>
|
|
209
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L619">src/Application.ts:619</a></li></ul></aside></div></li></ul></section>
|
|
210
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
211
|
+
<h3 class="tsd-anchor-link" id="_initialize"><code class="tsd-tag">Protected</code><span>_<wbr/>initialize</span><a href="#_initialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
212
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
213
|
+
<li class="">
|
|
214
|
+
<div class="tsd-signature tsd-anchor-link" id="_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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
215
|
+
<div class="tsd-description">
|
|
216
|
+
<div class="tsd-parameters">
|
|
217
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
218
|
+
<ul class="tsd-parameter-list">
|
|
219
|
+
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
220
|
+
<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">
|
|
221
|
+
<ul>
|
|
222
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L248">src/Application.ts:248</a></li></ul></aside></div></li></ul></section>
|
|
223
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
224
|
+
<h3 class="tsd-anchor-link" id="_initlogger"><code class="tsd-tag">Protected</code><span>_<wbr/>init<wbr/>Logger</span><a href="#_initlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
225
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
226
|
+
<li class="">
|
|
227
|
+
<div class="tsd-signature tsd-anchor-link" id="_initlogger-1"><span class="tsd-kind-call-signature">_initLogger</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
228
|
+
<div class="tsd-description">
|
|
229
|
+
<div class="tsd-parameters">
|
|
230
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
231
|
+
<ul class="tsd-parameter-list">
|
|
232
|
+
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span></li></ul></div>
|
|
233
|
+
<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">
|
|
234
|
+
<ul>
|
|
235
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L256">src/Application.ts:256</a></li></ul></aside></div></li></ul></section>
|
|
236
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
237
|
+
<h3 class="tsd-anchor-link" id="_onbeforereadyasync"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Before<wbr/>Ready<wbr/>Async</span><a href="#_onbeforereadyasync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
238
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
239
|
+
<li class="">
|
|
240
|
+
<div class="tsd-signature tsd-anchor-link" id="_onbeforereadyasync-1"><span class="tsd-kind-call-signature">_onBeforeReadyAsync</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
241
|
+
<div class="tsd-description">
|
|
242
|
+
<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">
|
|
243
|
+
<ul>
|
|
244
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L623">src/Application.ts:623</a></li></ul></aside></div></li></ul></section>
|
|
245
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
246
|
+
<h3 class="tsd-anchor-link" id="_onconfigload"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Config<wbr/>Load</span><a href="#_onconfigload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
247
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
248
|
+
<li class="">
|
|
249
|
+
<div class="tsd-signature tsd-anchor-link" id="_onconfigload-1"><span class="tsd-kind-call-signature">_onConfigLoad</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#_onconfigload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
250
|
+
<div class="tsd-description">
|
|
251
|
+
<div class="tsd-comment tsd-typography"><p>Invoked once the config has been loaded and ready to be used.</p>
|
|
252
|
+
</div>
|
|
253
|
+
<div class="tsd-parameters">
|
|
254
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
255
|
+
<ul class="tsd-parameter-list">
|
|
256
|
+
<li><span><span class="tsd-kind-parameter">config</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></span>
|
|
257
|
+
<div class="tsd-comment tsd-typography"><p>The config object (as defined in bt-config.json/bt-local-config.json)</p>
|
|
258
|
+
</div></li></ul></div>
|
|
259
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
260
|
+
<ul>
|
|
261
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L552">src/Application.ts:552</a></li></ul></aside></div></li></ul></section>
|
|
262
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
263
|
+
<h3 class="tsd-anchor-link" id="_onready"><code class="tsd-tag">Protected</code><span>_<wbr/>on<wbr/>Ready</span><a href="#_onready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
264
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
265
|
+
<li class="">
|
|
266
|
+
<div class="tsd-signature tsd-anchor-link" id="_onready-1"><span class="tsd-kind-call-signature">_onReady</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#_onready-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
267
|
+
<div class="tsd-description">
|
|
268
|
+
<div class="tsd-comment tsd-typography"><p>Invoked when the application is considered ready for operation.</p>
|
|
269
|
+
</div>
|
|
270
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
271
|
+
<ul>
|
|
272
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L628">src/Application.ts:628</a></li></ul></aside></div></li></ul></section>
|
|
273
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
274
|
+
<h3 class="tsd-anchor-link" id="capturerejectionsymbol"><code class="tsd-tag">Optional</code><span>[capture<wbr/>Rejection<wbr/>Symbol]</span><a href="#capturerejectionsymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
275
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
276
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
277
|
+
<div class="tsd-signature tsd-anchor-link" id="capturerejectionsymbol-1"><span class="tsd-kind-call-signature">"[captureRejectionSymbol]"</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">event</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><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#capturerejectionsymbol-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
278
|
+
<div class="tsd-description">
|
|
279
|
+
<div class="tsd-comment tsd-typography"><p>The <code>Symbol.for('nodejs.rejection')</code> method is called in case a
|
|
280
|
+
promise rejection happens when emitting an event and
|
|
281
|
+
<code>captureRejections</code> is enabled on the emitter.
|
|
282
|
+
It is possible to use <code>events.captureRejectionSymbol</code> in
|
|
283
|
+
place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
284
|
+
<pre><code class="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">captureRejectionSymbol</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">class</span><span class="hl-3"> </span><span class="hl-7">MyClass</span><span class="hl-3"> </span><span class="hl-0">extends</span><span class="hl-3"> </span><span class="hl-7">EventEmitter</span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-0">constructor</span><span class="hl-3">() {</span><br/><span class="hl-3"> </span><span class="hl-0">super</span><span class="hl-3">({ </span><span class="hl-4">captureRejections:</span><span class="hl-3"> </span><span class="hl-0">true</span><span class="hl-3"> });</span><br/><span class="hl-3"> }</span><br/><br/><span class="hl-3"> [</span><span class="hl-4">captureRejectionSymbol</span><span class="hl-3">](</span><span class="hl-4">err</span><span class="hl-3">, </span><span class="hl-4">event</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-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">'rejection happened for'</span><span class="hl-3">, </span><span class="hl-4">event</span><span class="hl-3">, </span><span class="hl-1">'with'</span><span class="hl-3">, </span><span class="hl-4">err</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">this</span><span class="hl-3">.</span><span class="hl-5">destroy</span><span class="hl-3">(</span><span class="hl-4">err</span><span class="hl-3">);</span><br/><span class="hl-3"> }</span><br/><br/><span class="hl-3"> </span><span class="hl-5">destroy</span><span class="hl-3">(</span><span class="hl-4">err</span><span class="hl-3">) {</span><br/><span class="hl-3"> </span><span class="hl-8">// Tear the resource down here.</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">}</span>
|
|
88
285
|
</code><button type="button">Copy</button></pre>
|
|
89
286
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
<
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
<
|
|
100
|
-
|
|
101
|
-
</div
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
<
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
</div
|
|
287
|
+
</div>
|
|
288
|
+
<div class="tsd-parameters">
|
|
289
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
290
|
+
<ul class="tsd-parameter-list">
|
|
291
|
+
<li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">Error</span></span></li>
|
|
292
|
+
<li><span><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></span></li>
|
|
293
|
+
<li><span><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></span></li></ul></div>
|
|
294
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
295
|
+
<div class="tsd-comment tsd-typography">
|
|
296
|
+
<div class="tsd-tag-since">
|
|
297
|
+
<h4 class="tsd-anchor-link" id="since">Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v13.4.0, v12.16.0</p>
|
|
298
|
+
</div></div><aside class="tsd-sources">
|
|
299
|
+
<p>Inherited from EventEmitter.[captureRejectionSymbol]</p>
|
|
300
|
+
<ul>
|
|
301
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:87</li></ul></aside></div></li></ul></section>
|
|
302
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
303
|
+
<h3 class="tsd-anchor-link" id="addlistener"><span>add<wbr/>Listener</span><a href="#addlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
304
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
305
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
306
|
+
<div class="tsd-signature tsd-anchor-link" id="addlistener-1"><span class="tsd-kind-call-signature">addListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#addlistenere">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addlistener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
307
|
+
<div class="tsd-description">
|
|
308
|
+
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
|
|
309
|
+
</div>
|
|
310
|
+
<section class="tsd-panel">
|
|
311
|
+
<h4>Type Parameters</h4>
|
|
312
|
+
<ul class="tsd-type-parameter-list">
|
|
313
|
+
<li><span id="addlistenere"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
314
|
+
<div class="tsd-parameters">
|
|
315
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
316
|
+
<ul class="tsd-parameter-list">
|
|
317
|
+
<li><span><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></span></li>
|
|
318
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span></li></ul></div>
|
|
319
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
320
|
+
<div class="tsd-comment tsd-typography">
|
|
321
|
+
<div class="tsd-tag-since">
|
|
322
|
+
<h4 class="tsd-anchor-link" id="since-1">Since<a href="#since-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
|
323
|
+
</div></div><aside class="tsd-sources">
|
|
324
|
+
<p>Inherited from EventEmitter.addListener</p>
|
|
325
|
+
<ul>
|
|
326
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:92</li></ul></aside></div></li></ul></section>
|
|
327
|
+
<section class="tsd-panel tsd-member">
|
|
328
|
+
<h3 class="tsd-anchor-link" id="attachhandler"><span>attach<wbr/>Handler</span><a href="#attachhandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
329
|
+
<ul class="tsd-signatures">
|
|
330
|
+
<li class="">
|
|
331
|
+
<div class="tsd-signature tsd-anchor-link" id="attachhandler-1"><span class="tsd-kind-call-signature">attachHandler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="Handler.html" class="tsd-signature-type tsd-kind-class">Handler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#attachhandler-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
332
|
+
<div class="tsd-description">
|
|
333
|
+
<div class="tsd-parameters">
|
|
334
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
335
|
+
<ul class="tsd-parameter-list">
|
|
336
|
+
<li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span>
|
|
337
|
+
<div class="tsd-comment tsd-typography"><p>The URL API path. E.g. /api/myService/myCommand/</p>
|
|
338
|
+
</div></li>
|
|
339
|
+
<li><span><span class="tsd-kind-parameter">handler</span>: <a href="Handler.html" class="tsd-signature-type tsd-kind-class">Handler</a></span></li></ul></div>
|
|
340
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
341
|
+
<ul>
|
|
342
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L405">src/Application.ts:405</a></li></ul></aside></div></li></ul></section>
|
|
343
|
+
<section class="tsd-panel tsd-member">
|
|
344
|
+
<h3 class="tsd-anchor-link" id="attachhandlerinstance"><span>attach<wbr/>Handler<wbr/>Instance</span><a href="#attachhandlerinstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
345
|
+
<ul class="tsd-signatures">
|
|
346
|
+
<li class="">
|
|
347
|
+
<div class="tsd-signature tsd-anchor-link" id="attachhandlerinstance-1"><span class="tsd-kind-call-signature">attachHandlerInstance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="Handler.html" class="tsd-signature-type tsd-kind-class">Handler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#attachhandlerinstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
348
|
+
<div class="tsd-description">
|
|
349
|
+
<div class="tsd-parameters">
|
|
350
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
351
|
+
<ul class="tsd-parameter-list">
|
|
352
|
+
<li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
353
|
+
<li><span><span class="tsd-kind-parameter">handler</span>: <a href="Handler.html" class="tsd-signature-type tsd-kind-class">Handler</a></span></li></ul></div>
|
|
354
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
355
|
+
<ul>
|
|
356
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L409">src/Application.ts:409</a></li></ul></aside></div></li></ul></section>
|
|
357
|
+
<section class="tsd-panel tsd-member">
|
|
358
|
+
<h3 class="tsd-anchor-link" id="close"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
359
|
+
<ul class="tsd-signatures">
|
|
360
|
+
<li class="">
|
|
361
|
+
<div class="tsd-signature tsd-anchor-link" id="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-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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
362
|
+
<div class="tsd-description">
|
|
363
|
+
<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">
|
|
364
|
+
<ul>
|
|
365
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L428">src/Application.ts:428</a></li></ul></aside></div></li></ul></section>
|
|
366
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
367
|
+
<h3 class="tsd-anchor-link" id="emit"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
368
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
369
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
370
|
+
<div class="tsd-signature tsd-anchor-link" id="emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emite">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
371
|
+
<div class="tsd-description">
|
|
372
|
+
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named
|
|
373
|
+
<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
|
113
374
|
to each.</p>
|
|
114
375
|
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
|
115
|
-
<pre><code class="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-
|
|
376
|
+
<pre><code class="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-9">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-9">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>
|
|
116
377
|
</code><button type="button">Copy</button></pre>
|
|
117
378
|
|
|
118
|
-
</div
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
<
|
|
379
|
+
</div>
|
|
380
|
+
<section class="tsd-panel">
|
|
381
|
+
<h4>Type Parameters</h4>
|
|
382
|
+
<ul class="tsd-type-parameter-list">
|
|
383
|
+
<li><span id="emite"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
384
|
+
<div class="tsd-parameters">
|
|
385
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
386
|
+
<ul class="tsd-parameter-list">
|
|
387
|
+
<li><span><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></span></li>
|
|
388
|
+
<li><span><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></span></li></ul></div>
|
|
389
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
390
|
+
<div class="tsd-comment tsd-typography">
|
|
391
|
+
<div class="tsd-tag-since">
|
|
392
|
+
<h4 class="tsd-anchor-link" id="since-2">Since<a href="#since-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
|
393
|
+
</div></div><aside class="tsd-sources">
|
|
394
|
+
<p>Inherited from EventEmitter.emit</p>
|
|
395
|
+
<ul>
|
|
396
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:134</li></ul></aside></div></li></ul></section>
|
|
397
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
398
|
+
<h3 class="tsd-anchor-link" id="eventnames"><span>event<wbr/>Names</span><a href="#eventnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
399
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
400
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
401
|
+
<div class="tsd-signature tsd-anchor-link" id="eventnames-1"><span class="tsd-kind-call-signature">eventNames</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><a href="#eventnames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
402
|
+
<div class="tsd-description">
|
|
403
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
|
404
|
+
listeners.</p>
|
|
405
|
+
<pre><code class="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-9">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-9">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>
|
|
122
406
|
</code><button type="button">Copy</button></pre>
|
|
123
407
|
|
|
124
|
-
</div
|
|
125
|
-
|
|
126
|
-
<
|
|
127
|
-
<
|
|
128
|
-
|
|
129
|
-
|
|
408
|
+
</div>
|
|
409
|
+
<h4 class="tsd-returns-title">Returns (<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></h4>
|
|
410
|
+
<div class="tsd-comment tsd-typography">
|
|
411
|
+
<div class="tsd-tag-since">
|
|
412
|
+
<h4 class="tsd-anchor-link" id="since-3">Since<a href="#since-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
|
413
|
+
</div></div><aside class="tsd-sources">
|
|
414
|
+
<p>Inherited from EventEmitter.eventNames</p>
|
|
415
|
+
<ul>
|
|
416
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:154</li></ul></aside></div></li></ul></section>
|
|
417
|
+
<section class="tsd-panel tsd-member">
|
|
418
|
+
<h3 class="tsd-anchor-link" id="getcmdlineargs"><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span><a href="#getcmdlineargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
419
|
+
<ul class="tsd-signatures">
|
|
420
|
+
<li class="">
|
|
421
|
+
<div class="tsd-signature tsd-anchor-link" id="getcmdlineargs-1"><span class="tsd-kind-call-signature">getCmdLineArgs</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IStormCLIArgs.html" class="tsd-signature-type tsd-kind-interface">IStormCLIArgs</a><a href="#getcmdlineargs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
422
|
+
<div class="tsd-description">
|
|
423
|
+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/IStormCLIArgs.html" class="tsd-signature-type tsd-kind-interface">IStormCLIArgs</a></h4><p>command line arguments</p>
|
|
424
|
+
<aside class="tsd-sources">
|
|
425
|
+
<ul>
|
|
426
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L579">src/Application.ts:579</a></li></ul></aside></div></li></ul></section>
|
|
427
|
+
<section class="tsd-panel tsd-member">
|
|
428
|
+
<h3 class="tsd-anchor-link" id="getconfig"><span>get<wbr/>Config</span><a href="#getconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
429
|
+
<ul class="tsd-signatures">
|
|
430
|
+
<li class="">
|
|
431
|
+
<div class="tsd-signature tsd-anchor-link" id="getconfig-1"><span class="tsd-kind-call-signature">getConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><a href="#getconfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
432
|
+
<div class="tsd-description">
|
|
433
|
+
<h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a></h4><p>the config object.</p>
|
|
434
|
+
<aside class="tsd-sources">
|
|
435
|
+
<ul>
|
|
436
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L536">src/Application.ts:536</a></li></ul></aside></div></li></ul></section>
|
|
437
|
+
<section class="tsd-panel tsd-member">
|
|
438
|
+
<h3 class="tsd-anchor-link" id="getconfigfilepath"><span>get<wbr/>Config<wbr/>File<wbr/>Path</span><a href="#getconfigfilepath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
439
|
+
<ul class="tsd-signatures">
|
|
440
|
+
<li class="">
|
|
441
|
+
<div class="tsd-signature tsd-anchor-link" id="getconfigfilepath-1"><span class="tsd-kind-call-signature">getConfigFilePath</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getconfigfilepath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
442
|
+
<div class="tsd-description">
|
|
443
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
444
|
+
<ul>
|
|
445
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L487">src/Application.ts:487</a></li></ul></aside></div></li></ul></section>
|
|
446
|
+
<section class="tsd-panel tsd-member">
|
|
447
|
+
<h3 class="tsd-anchor-link" id="getconfigfromcliargs"><span>get<wbr/>Config<wbr/>From<wbr/>CLI<wbr/>Args</span><a href="#getconfigfromcliargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
448
|
+
<ul class="tsd-signatures">
|
|
449
|
+
<li class="">
|
|
450
|
+
<div class="tsd-signature tsd-anchor-link" id="getconfigfromcliargs-1"><span class="tsd-kind-call-signature">getConfigFromCLIArgs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</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">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getconfigfromcliargs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
451
|
+
<div class="tsd-description">
|
|
452
|
+
<div class="tsd-comment tsd-typography"><p>Override this method to map CLI args to customConfig</p>
|
|
453
|
+
</div>
|
|
454
|
+
<div class="tsd-parameters">
|
|
455
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
456
|
+
<ul class="tsd-parameter-list">
|
|
457
|
+
<li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span></span></li></ul></div>
|
|
458
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
459
|
+
<ul>
|
|
460
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L387">src/Application.ts:387</a></li></ul></aside></div></li></ul></section>
|
|
461
|
+
<section class="tsd-panel tsd-member">
|
|
462
|
+
<h3 class="tsd-anchor-link" id="getdb"><span>get<wbr/>DB</span><a href="#getdb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
463
|
+
<ul class="tsd-signatures">
|
|
464
|
+
<li class="">
|
|
465
|
+
<div class="tsd-signature tsd-anchor-link" id="getdb-1"><span class="tsd-kind-call-signature">getDB</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><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span><a href="#getdb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
466
|
+
<div class="tsd-description">
|
|
467
|
+
<h4 class="tsd-returns-title">Returns <a href="Database.html" class="tsd-signature-type tsd-kind-class">Database</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconfig">TDBConfig</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tdbconnectionapi">TDBConnectionAPI</a><span class="tsd-signature-symbol">></span></h4><p>the database pool. This will need to be casted based on your preferred database dialect.</p>
|
|
468
|
+
<aside class="tsd-sources">
|
|
469
|
+
<ul>
|
|
470
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L572">src/Application.ts:572</a></li></ul></aside></div></li></ul></section>
|
|
471
|
+
<section class="tsd-panel tsd-member">
|
|
472
|
+
<h3 class="tsd-anchor-link" id="getdefaultportforprometheus"><span>get<wbr/>Default<wbr/>Port<wbr/>For<wbr/>Prometheus</span><a href="#getdefaultportforprometheus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
473
|
+
<ul class="tsd-signatures">
|
|
474
|
+
<li class="">
|
|
475
|
+
<div class="tsd-signature tsd-anchor-link" id="getdefaultportforprometheus-1"><span class="tsd-kind-call-signature">getDefaultPortForPrometheus</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getdefaultportforprometheus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
476
|
+
<div class="tsd-description">
|
|
477
|
+
<div class="tsd-comment tsd-typography"><p>Default algorithm is to take main port, and add 595 to it.
|
|
130
478
|
Still -- it is better to explicitly set the prometheus port.</p>
|
|
131
|
-
</div
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
<
|
|
136
|
-
|
|
137
|
-
<
|
|
479
|
+
</div>
|
|
480
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
481
|
+
<ul>
|
|
482
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L164">src/Application.ts:164</a></li></ul></aside></div></li></ul></section>
|
|
483
|
+
<section class="tsd-panel tsd-member">
|
|
484
|
+
<h3 class="tsd-anchor-link" id="getlocalconfigfilepath"><span>get<wbr/>Local<wbr/>Config<wbr/>File<wbr/>Path</span><a href="#getlocalconfigfilepath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
485
|
+
<ul class="tsd-signatures">
|
|
486
|
+
<li class="">
|
|
487
|
+
<div class="tsd-signature tsd-anchor-link" id="getlocalconfigfilepath-1"><span class="tsd-kind-call-signature">getLocalConfigFilePath</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getlocalconfigfilepath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
488
|
+
<div class="tsd-description">
|
|
489
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
490
|
+
<ul>
|
|
491
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L491">src/Application.ts:491</a></li></ul></aside></div></li></ul></section>
|
|
492
|
+
<section class="tsd-panel tsd-member">
|
|
493
|
+
<h3 class="tsd-anchor-link" id="getlogger"><span>get<wbr/>Logger</span><a href="#getlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
494
|
+
<ul class="tsd-signatures">
|
|
495
|
+
<li class="">
|
|
496
|
+
<div class="tsd-signature tsd-anchor-link" id="getlogger-1"><span class="tsd-kind-call-signature">getLogger</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BaseLogger</span><a href="#getlogger-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
497
|
+
<div class="tsd-description">
|
|
498
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BaseLogger</span></h4><aside class="tsd-sources">
|
|
499
|
+
<ul>
|
|
500
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L321">src/Application.ts:321</a></li></ul></aside></div></li></ul></section>
|
|
501
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
502
|
+
<h3 class="tsd-anchor-link" id="getmaxlisteners"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getmaxlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
503
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
504
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
505
|
+
<div class="tsd-signature tsd-anchor-link" id="getmaxlisteners-1"><span class="tsd-kind-call-signature">getMaxListeners</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmaxlisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
506
|
+
<div class="tsd-description">
|
|
507
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
|
508
|
+
set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
509
|
+
<code>events.defaultMaxListeners</code>.</p>
|
|
510
|
+
</div>
|
|
511
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
512
|
+
<div class="tsd-comment tsd-typography">
|
|
513
|
+
<div class="tsd-tag-since">
|
|
514
|
+
<h4 class="tsd-anchor-link" id="since-4">Since<a href="#since-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v1.0.0</p>
|
|
515
|
+
</div></div><aside class="tsd-sources">
|
|
516
|
+
<p>Inherited from EventEmitter.getMaxListeners</p>
|
|
517
|
+
<ul>
|
|
518
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:161</li></ul></aside></div></li></ul></section>
|
|
519
|
+
<section class="tsd-panel tsd-member">
|
|
520
|
+
<h3 class="tsd-anchor-link" id="getname"><span>get<wbr/>Name</span><a href="#getname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
521
|
+
<ul class="tsd-signatures">
|
|
522
|
+
<li class="">
|
|
523
|
+
<div class="tsd-signature tsd-anchor-link" id="getname-1"><span class="tsd-kind-call-signature">getName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
524
|
+
<div class="tsd-description">
|
|
525
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the application name</p>
|
|
526
|
+
<aside class="tsd-sources">
|
|
527
|
+
<ul>
|
|
528
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L525">src/Application.ts:525</a></li></ul></aside></div></li></ul></section>
|
|
529
|
+
<section class="tsd-panel tsd-member">
|
|
530
|
+
<h3 class="tsd-anchor-link" id="getport"><span>get<wbr/>Port</span><a href="#getport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
531
|
+
<ul class="tsd-signatures">
|
|
532
|
+
<li class="">
|
|
533
|
+
<div class="tsd-signature tsd-anchor-link" id="getport-1"><span class="tsd-kind-call-signature">getPort</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getport-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
534
|
+
<div class="tsd-description">
|
|
535
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
536
|
+
<ul>
|
|
537
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L325">src/Application.ts:325</a></li></ul></aside></div></li></ul></section>
|
|
538
|
+
<section class="tsd-panel tsd-member">
|
|
539
|
+
<h3 class="tsd-anchor-link" id="getprogram"><span>get<wbr/>Program</span><a href="#getprogram" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
540
|
+
<ul class="tsd-signatures">
|
|
541
|
+
<li class="">
|
|
542
|
+
<div class="tsd-signature tsd-anchor-link" id="getprogram-1"><span class="tsd-kind-call-signature">getProgram</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a><a href="#getprogram-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
543
|
+
<div class="tsd-description">
|
|
544
|
+
<h4 class="tsd-returns-title">Returns <a href="Command.html" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources">
|
|
545
|
+
<ul>
|
|
546
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L379">src/Application.ts:379</a></li></ul></aside></div></li></ul></section>
|
|
547
|
+
<section class="tsd-panel tsd-member">
|
|
548
|
+
<h3 class="tsd-anchor-link" id="getrequestsizelimit"><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span><a href="#getrequestsizelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
549
|
+
<ul class="tsd-signatures">
|
|
550
|
+
<li class="">
|
|
551
|
+
<div class="tsd-signature tsd-anchor-link" id="getrequestsizelimit-1"><span class="tsd-kind-call-signature">getRequestSizeLimit</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getrequestsizelimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
552
|
+
<div class="tsd-description">
|
|
553
|
+
<div class="tsd-comment tsd-typography"><p>The maximum size limit for incoming requests that this service needs to handle.</p>
|
|
554
|
+
</div>
|
|
555
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
556
|
+
<ul>
|
|
557
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L394">src/Application.ts:394</a></li></ul></aside></div></li></ul></section>
|
|
558
|
+
<section class="tsd-panel tsd-member">
|
|
559
|
+
<h3 class="tsd-anchor-link" id="getshard"><span>get<wbr/>Shard</span><a href="#getshard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
560
|
+
<ul class="tsd-signatures">
|
|
561
|
+
<li class="">
|
|
562
|
+
<div class="tsd-signature tsd-anchor-link" id="getshard-1"><span class="tsd-kind-call-signature">getShard</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getshard-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
563
|
+
<div class="tsd-description">
|
|
564
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
565
|
+
<ul>
|
|
566
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L369">src/Application.ts:369</a></li></ul></aside></div></li></ul></section>
|
|
567
|
+
<section class="tsd-panel tsd-member">
|
|
568
|
+
<h3 class="tsd-anchor-link" id="gettokenmanager"><span>get<wbr/>Token<wbr/>Manager</span><a href="#gettokenmanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
569
|
+
<ul class="tsd-signatures">
|
|
570
|
+
<li class="">
|
|
571
|
+
<div class="tsd-signature tsd-anchor-link" id="gettokenmanager-1"><span class="tsd-kind-call-signature">getTokenManager</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><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">></span><a href="#gettokenmanager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
572
|
+
<div class="tsd-description">
|
|
573
|
+
<h4 class="tsd-returns-title">Returns <a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">></span></h4><p>the token manager</p>
|
|
574
|
+
<aside class="tsd-sources">
|
|
575
|
+
<ul>
|
|
576
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L565">src/Application.ts:565</a></li></ul></aside></div></li></ul></section>
|
|
577
|
+
<section class="tsd-panel tsd-member">
|
|
578
|
+
<h3 class="tsd-anchor-link" id="getversion"><span>get<wbr/>Version</span><a href="#getversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
579
|
+
<ul class="tsd-signatures">
|
|
580
|
+
<li class="">
|
|
581
|
+
<div class="tsd-signature tsd-anchor-link" id="getversion-1"><span class="tsd-kind-call-signature">getVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
582
|
+
<div class="tsd-description">
|
|
583
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
584
|
+
<ul>
|
|
585
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L336">src/Application.ts:336</a></li></ul></aside></div></li></ul></section>
|
|
586
|
+
<section class="tsd-panel tsd-member">
|
|
587
|
+
<h3 class="tsd-anchor-link" id="isprometheusenabled"><span>is<wbr/>Prometheus<wbr/>Enabled</span><a href="#isprometheusenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
588
|
+
<ul class="tsd-signatures">
|
|
589
|
+
<li class="">
|
|
590
|
+
<div class="tsd-signature tsd-anchor-link" id="isprometheusenabled-1"><span class="tsd-kind-call-signature">isPrometheusEnabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isprometheusenabled-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
591
|
+
<div class="tsd-description">
|
|
592
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
593
|
+
<ul>
|
|
594
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L373">src/Application.ts:373</a></li></ul></aside></div></li></ul></section>
|
|
595
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
596
|
+
<h3 class="tsd-anchor-link" id="listenercount"><span>listener<wbr/>Count</span><a href="#listenercount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
597
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
598
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
599
|
+
<div class="tsd-signature tsd-anchor-link" id="listenercount-1"><span class="tsd-kind-call-signature">listenerCount</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercounte">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#listenercount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
600
|
+
<div class="tsd-description">
|
|
601
|
+
<div class="tsd-comment tsd-typography"><p>Returns the number of listeners listening for the event named <code>eventName</code>.
|
|
138
602
|
If <code>listener</code> is provided, it will return how many times the listener is found
|
|
139
603
|
in the list of the listeners of the event.</p>
|
|
140
|
-
</div
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
604
|
+
</div>
|
|
605
|
+
<section class="tsd-panel">
|
|
606
|
+
<h4>Type Parameters</h4>
|
|
607
|
+
<ul class="tsd-type-parameter-list">
|
|
608
|
+
<li><span id="listenercounte"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
609
|
+
<div class="tsd-parameters">
|
|
610
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
611
|
+
<ul class="tsd-parameter-list">
|
|
612
|
+
<li><span><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></span>
|
|
613
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
|
614
|
+
</div></li>
|
|
615
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">listener</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-type">any</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></span>
|
|
616
|
+
<div class="tsd-comment tsd-typography"><p>The event handler function</p>
|
|
617
|
+
</div></li></ul></div>
|
|
618
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
619
|
+
<div class="tsd-comment tsd-typography">
|
|
620
|
+
<div class="tsd-tag-since">
|
|
621
|
+
<h4 class="tsd-anchor-link" id="since-5">Since<a href="#since-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v3.2.0</p>
|
|
622
|
+
</div></div><aside class="tsd-sources">
|
|
623
|
+
<p>Inherited from EventEmitter.listenerCount</p>
|
|
624
|
+
<ul>
|
|
625
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:170</li></ul></aside></div></li></ul></section>
|
|
626
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
627
|
+
<h3 class="tsd-anchor-link" id="listeners"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
628
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
629
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
630
|
+
<div class="tsd-signature tsd-anchor-link" id="listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#listenerse">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/><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-kind-parameter">args</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-symbol">=></span> <span class="tsd-signature-type">void</span>)<span class="tsd-signature-symbol">[]</span><a href="#listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
631
|
+
<div class="tsd-description">
|
|
632
|
+
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
144
633
|
<pre><code class="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>
|
|
145
634
|
</code><button type="button">Copy</button></pre>
|
|
146
635
|
|
|
147
|
-
</div
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
<
|
|
636
|
+
</div>
|
|
637
|
+
<section class="tsd-panel">
|
|
638
|
+
<h4>Type Parameters</h4>
|
|
639
|
+
<ul class="tsd-type-parameter-list">
|
|
640
|
+
<li><span id="listenerse"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
641
|
+
<div class="tsd-parameters">
|
|
642
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
643
|
+
<ul class="tsd-parameter-list">
|
|
644
|
+
<li><span><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></span></li></ul></div>
|
|
645
|
+
<h4 class="tsd-returns-title">Returns (<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-type">any</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>)<span class="tsd-signature-symbol">[]</span></h4>
|
|
646
|
+
<div class="tsd-comment tsd-typography">
|
|
647
|
+
<div class="tsd-tag-since">
|
|
648
|
+
<h4 class="tsd-anchor-link" id="since-6">Since<a href="#since-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
|
649
|
+
</div></div><aside class="tsd-sources">
|
|
650
|
+
<p>Inherited from EventEmitter.listeners</p>
|
|
651
|
+
<ul>
|
|
652
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:186</li></ul></aside></div></li></ul></section>
|
|
653
|
+
<section class="tsd-panel tsd-member">
|
|
654
|
+
<h3 class="tsd-anchor-link" id="loadconfig"><span class="deprecated">load<wbr/>Config</span><a href="#loadconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
655
|
+
<ul class="tsd-signatures">
|
|
656
|
+
<li class="">
|
|
657
|
+
<div class="tsd-signature tsd-anchor-link" id="loadconfig-1"><span class="tsd-kind-call-signature">loadConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">></span><a href="#loadconfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
658
|
+
<div class="tsd-description">
|
|
659
|
+
<div class="tsd-parameters">
|
|
660
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
661
|
+
<ul class="tsd-parameter-list">
|
|
662
|
+
<li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span>
|
|
663
|
+
<div class="tsd-comment tsd-typography"><p>The directory path that contains bt-config.json and bt-local-config.json</p>
|
|
664
|
+
</div></li></ul></div>
|
|
665
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tconfig">TConfig</a><span class="tsd-signature-symbol">></span></h4>
|
|
666
|
+
<div class="tsd-comment tsd-typography">
|
|
667
|
+
<div class="tsd-tag-deprecated">
|
|
668
|
+
<h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Supply the configs via --config and --local-config arguments</p>
|
|
669
|
+
</div></div><aside class="tsd-sources">
|
|
670
|
+
<ul>
|
|
671
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L465">src/Application.ts:465</a></li></ul></aside></div></li></ul></section>
|
|
672
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
673
|
+
<h3 class="tsd-anchor-link" id="off"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
674
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
675
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
676
|
+
<div class="tsd-signature tsd-anchor-link" id="off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#offe">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
677
|
+
<div class="tsd-description">
|
|
678
|
+
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
|
679
|
+
</div>
|
|
680
|
+
<section class="tsd-panel">
|
|
681
|
+
<h4>Type Parameters</h4>
|
|
682
|
+
<ul class="tsd-type-parameter-list">
|
|
683
|
+
<li><span id="offe"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
684
|
+
<div class="tsd-parameters">
|
|
685
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
686
|
+
<ul class="tsd-parameter-list">
|
|
687
|
+
<li><span><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></span></li>
|
|
688
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span></li></ul></div>
|
|
689
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
690
|
+
<div class="tsd-comment tsd-typography">
|
|
691
|
+
<div class="tsd-tag-since">
|
|
692
|
+
<h4 class="tsd-anchor-link" id="since-7">Since<a href="#since-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v10.0.0</p>
|
|
693
|
+
</div></div><aside class="tsd-sources">
|
|
694
|
+
<p>Inherited from EventEmitter.off</p>
|
|
695
|
+
<ul>
|
|
696
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:191</li></ul></aside></div></li></ul></section>
|
|
697
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
698
|
+
<h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
699
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
700
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
701
|
+
<div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#one">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
702
|
+
<div class="tsd-description">
|
|
703
|
+
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the end of the listeners array for the
|
|
704
|
+
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
705
|
+
already been added. Multiple calls passing the same combination of <code>eventName</code>
|
|
706
|
+
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
707
|
+
times.</p>
|
|
156
708
|
<pre><code class="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>
|
|
157
709
|
</code><button type="button">Copy</button></pre>
|
|
158
710
|
|
|
159
711
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
160
|
-
<p>By default, event listeners are invoked in the order they are added. The
|
|
712
|
+
<p>By default, event listeners are invoked in the order they are added. The
|
|
713
|
+
<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
|
161
714
|
event listener to the beginning of the listeners array.</p>
|
|
162
|
-
<pre><code class="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-
|
|
715
|
+
<pre><code class="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-9">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>
|
|
163
716
|
</code><button type="button">Copy</button></pre>
|
|
164
717
|
|
|
165
|
-
</div
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
718
|
+
</div>
|
|
719
|
+
<section class="tsd-panel">
|
|
720
|
+
<h4>Type Parameters</h4>
|
|
721
|
+
<ul class="tsd-type-parameter-list">
|
|
722
|
+
<li><span id="one"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
723
|
+
<div class="tsd-parameters">
|
|
724
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
725
|
+
<ul class="tsd-parameter-list">
|
|
726
|
+
<li><span><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></span>
|
|
727
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
728
|
+
</div></li>
|
|
729
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span>
|
|
730
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
731
|
+
</div></li></ul></div>
|
|
732
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
733
|
+
<div class="tsd-comment tsd-typography">
|
|
734
|
+
<div class="tsd-tag-since">
|
|
735
|
+
<h4 class="tsd-anchor-link" id="since-8">Since<a href="#since-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.101</p>
|
|
736
|
+
</div></div><aside class="tsd-sources">
|
|
737
|
+
<p>Inherited from EventEmitter.on</p>
|
|
738
|
+
<ul>
|
|
739
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:225</li></ul></aside></div></li></ul></section>
|
|
740
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
741
|
+
<h3 class="tsd-anchor-link" id="once"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
742
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
743
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
744
|
+
<div class="tsd-signature tsd-anchor-link" id="once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncee">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
745
|
+
<div class="tsd-description">
|
|
746
|
+
<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
|
|
169
747
|
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
|
170
748
|
<pre><code class="js"><span class="hl-4">server</span><span class="hl-3">.</span><span class="hl-5">once</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>
|
|
171
749
|
</code><button type="button">Copy</button></pre>
|
|
172
750
|
|
|
173
751
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
174
|
-
<p>By default, event listeners are invoked in the order they are added. The
|
|
752
|
+
<p>By default, event listeners are invoked in the order they are added. The
|
|
753
|
+
<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
|
175
754
|
event listener to the beginning of the listeners array.</p>
|
|
176
|
-
<pre><code class="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-
|
|
755
|
+
<pre><code class="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-9">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>
|
|
177
756
|
</code><button type="button">Copy</button></pre>
|
|
178
757
|
|
|
179
|
-
</div
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
758
|
+
</div>
|
|
759
|
+
<section class="tsd-panel">
|
|
760
|
+
<h4>Type Parameters</h4>
|
|
761
|
+
<ul class="tsd-type-parameter-list">
|
|
762
|
+
<li><span id="oncee"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
763
|
+
<div class="tsd-parameters">
|
|
764
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
765
|
+
<ul class="tsd-parameter-list">
|
|
766
|
+
<li><span><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></span>
|
|
767
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
768
|
+
</div></li>
|
|
769
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span>
|
|
770
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
771
|
+
</div></li></ul></div>
|
|
772
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
773
|
+
<div class="tsd-comment tsd-typography">
|
|
774
|
+
<div class="tsd-tag-since">
|
|
775
|
+
<h4 class="tsd-anchor-link" id="since-9">Since<a href="#since-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.3.0</p>
|
|
776
|
+
</div></div><aside class="tsd-sources">
|
|
777
|
+
<p>Inherited from EventEmitter.once</p>
|
|
778
|
+
<ul>
|
|
779
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:256</li></ul></aside></div></li></ul></section>
|
|
780
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
781
|
+
<h3 class="tsd-anchor-link" id="prependlistener"><span>prepend<wbr/>Listener</span><a href="#prependlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
782
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
783
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
784
|
+
<div class="tsd-signature tsd-anchor-link" id="prependlistener-1"><span class="tsd-kind-call-signature">prependListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#prependlistenere">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#prependlistener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
785
|
+
<div class="tsd-description">
|
|
786
|
+
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
|
183
787
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
184
788
|
already been added. Multiple calls passing the same combination of <code>eventName</code>
|
|
185
|
-
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
789
|
+
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
790
|
+
times.</p>
|
|
186
791
|
<pre><code class="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>
|
|
187
792
|
</code><button type="button">Copy</button></pre>
|
|
188
793
|
|
|
189
794
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
190
|
-
</div
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
795
|
+
</div>
|
|
796
|
+
<section class="tsd-panel">
|
|
797
|
+
<h4>Type Parameters</h4>
|
|
798
|
+
<ul class="tsd-type-parameter-list">
|
|
799
|
+
<li><span id="prependlistenere"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
800
|
+
<div class="tsd-parameters">
|
|
801
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
802
|
+
<ul class="tsd-parameter-list">
|
|
803
|
+
<li><span><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></span>
|
|
804
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
805
|
+
</div></li>
|
|
806
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span>
|
|
807
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
808
|
+
</div></li></ul></div>
|
|
809
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
810
|
+
<div class="tsd-comment tsd-typography">
|
|
811
|
+
<div class="tsd-tag-since">
|
|
812
|
+
<h4 class="tsd-anchor-link" id="since-10">Since<a href="#since-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
|
813
|
+
</div></div><aside class="tsd-sources">
|
|
814
|
+
<p>Inherited from EventEmitter.prependListener</p>
|
|
815
|
+
<ul>
|
|
816
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:275</li></ul></aside></div></li></ul></section>
|
|
817
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
818
|
+
<h3 class="tsd-anchor-link" id="prependoncelistener"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependoncelistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
819
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
820
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
821
|
+
<div class="tsd-signature tsd-anchor-link" id="prependoncelistener-1"><span class="tsd-kind-call-signature">prependOnceListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#prependoncelistenere">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#prependoncelistener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
822
|
+
<div class="tsd-description">
|
|
823
|
+
<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
|
|
824
|
+
<em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
|
194
825
|
listener is removed, and then invoked.</p>
|
|
195
826
|
<pre><code class="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>
|
|
196
827
|
</code><button type="button">Copy</button></pre>
|
|
197
828
|
|
|
198
829
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
199
|
-
</div
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
830
|
+
</div>
|
|
831
|
+
<section class="tsd-panel">
|
|
832
|
+
<h4>Type Parameters</h4>
|
|
833
|
+
<ul class="tsd-type-parameter-list">
|
|
834
|
+
<li><span id="prependoncelistenere"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
835
|
+
<div class="tsd-parameters">
|
|
836
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
837
|
+
<ul class="tsd-parameter-list">
|
|
838
|
+
<li><span><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></span>
|
|
839
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
840
|
+
</div></li>
|
|
841
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span>
|
|
842
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
843
|
+
</div></li></ul></div>
|
|
844
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
845
|
+
<div class="tsd-comment tsd-typography">
|
|
846
|
+
<div class="tsd-tag-since">
|
|
847
|
+
<h4 class="tsd-anchor-link" id="since-11">Since<a href="#since-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v6.0.0</p>
|
|
848
|
+
</div></div><aside class="tsd-sources">
|
|
849
|
+
<p>Inherited from EventEmitter.prependOnceListener</p>
|
|
850
|
+
<ul>
|
|
851
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:292</li></ul></aside></div></li></ul></section>
|
|
852
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
853
|
+
<h3 class="tsd-anchor-link" id="rawlisteners"><span>raw<wbr/>Listeners</span><a href="#rawlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
854
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
855
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
856
|
+
<div class="tsd-signature tsd-anchor-link" id="rawlisteners-1"><span class="tsd-kind-call-signature">rawListeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#rawlistenerse">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/><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-kind-parameter">args</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-symbol">=></span> <span class="tsd-signature-type">void</span>)<span class="tsd-signature-symbol">[]</span><a href="#rawlisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
857
|
+
<div class="tsd-description">
|
|
858
|
+
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
|
203
859
|
including any wrappers (such as those created by <code>.once()</code>).</p>
|
|
204
|
-
<pre><code class="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-
|
|
860
|
+
<pre><code class="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-9">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-9">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-9">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-9">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>
|
|
205
861
|
</code><button type="button">Copy</button></pre>
|
|
206
862
|
|
|
207
|
-
</div
|
|
208
|
-
|
|
863
|
+
</div>
|
|
864
|
+
<section class="tsd-panel">
|
|
865
|
+
<h4>Type Parameters</h4>
|
|
866
|
+
<ul class="tsd-type-parameter-list">
|
|
867
|
+
<li><span id="rawlistenerse"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
868
|
+
<div class="tsd-parameters">
|
|
869
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
870
|
+
<ul class="tsd-parameter-list">
|
|
871
|
+
<li><span><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></span></li></ul></div>
|
|
872
|
+
<h4 class="tsd-returns-title">Returns (<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-type">any</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>)<span class="tsd-signature-symbol">[]</span></h4>
|
|
873
|
+
<div class="tsd-comment tsd-typography">
|
|
874
|
+
<div class="tsd-tag-since">
|
|
875
|
+
<h4 class="tsd-anchor-link" id="since-12">Since<a href="#since-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v9.4.0</p>
|
|
876
|
+
</div></div><aside class="tsd-sources">
|
|
877
|
+
<p>Inherited from EventEmitter.rawListeners</p>
|
|
878
|
+
<ul>
|
|
879
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:326</li></ul></aside></div></li></ul></section>
|
|
880
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
881
|
+
<h3 class="tsd-anchor-link" id="removealllisteners"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removealllisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
882
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
883
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
884
|
+
<div class="tsd-signature tsd-anchor-link" id="removealllisteners-1"><span class="tsd-kind-call-signature">removeAllListeners</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#removealllistenerse">E</a> <span class="tsd-signature-keyword">extends</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><span class="tsd-kind-parameter">eventName</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> <span class="tsd-signature-type">this</span><a href="#removealllisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
885
|
+
<div class="tsd-description">
|
|
886
|
+
<div class="tsd-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
|
209
887
|
<p>It is bad practice to remove listeners added elsewhere in the code,
|
|
210
888
|
particularly when the <code>EventEmitter</code> instance was created by some other
|
|
211
889
|
component or module (e.g. sockets or file streams).</p>
|
|
212
890
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
213
|
-
</div
|
|
214
|
-
|
|
891
|
+
</div>
|
|
892
|
+
<section class="tsd-panel">
|
|
893
|
+
<h4>Type Parameters</h4>
|
|
894
|
+
<ul class="tsd-type-parameter-list">
|
|
895
|
+
<li><span id="removealllistenerse"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
896
|
+
<div class="tsd-parameters">
|
|
897
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
898
|
+
<ul class="tsd-parameter-list">
|
|
899
|
+
<li><span><code class="tsd-tag">Optional</code><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></span></li></ul></div>
|
|
900
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
901
|
+
<div class="tsd-comment tsd-typography">
|
|
902
|
+
<div class="tsd-tag-since">
|
|
903
|
+
<h4 class="tsd-anchor-link" id="since-13">Since<a href="#since-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
|
904
|
+
</div></div><aside class="tsd-sources">
|
|
905
|
+
<p>Inherited from EventEmitter.removeAllListeners</p>
|
|
906
|
+
<ul>
|
|
907
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:338</li></ul></aside></div></li></ul></section>
|
|
908
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
909
|
+
<h3 class="tsd-anchor-link" id="removelistener"><span>remove<wbr/>Listener</span><a href="#removelistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
910
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
911
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
912
|
+
<div class="tsd-signature tsd-anchor-link" id="removelistener-1"><span class="tsd-kind-call-signature">removeListener</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#removelistenere">E</a> <span class="tsd-signature-keyword">extends</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><br/> <span class="tsd-kind-parameter">eventName</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><br/> <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-type">any</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><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#removelistener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
913
|
+
<div class="tsd-description">
|
|
914
|
+
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named
|
|
915
|
+
<code>eventName</code>.</p>
|
|
215
916
|
<pre><code class="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>
|
|
216
917
|
</code><button type="button">Copy</button></pre>
|
|
217
918
|
|
|
@@ -220,153 +921,125 @@ listener array. If any single listener has been added multiple times to the
|
|
|
220
921
|
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
|
|
221
922
|
called multiple times to remove each instance.</p>
|
|
222
923
|
<p>Once an event is emitted, all listeners attached to it at the
|
|
223
|
-
time of emitting are called in order. This implies that any
|
|
224
|
-
|
|
225
|
-
<
|
|
924
|
+
time of emitting are called in order. This implies that any
|
|
925
|
+
<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and
|
|
926
|
+
<em>before</em> the last listener finishes execution will not remove them from
|
|
927
|
+
<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
|
928
|
+
<pre><code class="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">class</span><span class="hl-3"> </span><span class="hl-7">MyEmitter</span><span class="hl-3"> </span><span class="hl-0">extends</span><span class="hl-3"> </span><span class="hl-7">EventEmitter</span><span class="hl-3"> {}</span><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-9">myEmitter</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">MyEmitter</span><span class="hl-3">();</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-5">callbackA</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">'A'</span><span class="hl-3">);</span><br/><span class="hl-3"> </span><span class="hl-4">myEmitter</span><span class="hl-3">.</span><span class="hl-5">removeListener</span><span class="hl-3">(</span><span class="hl-1">'event'</span><span class="hl-3">, </span><span class="hl-4">callbackB</span><span class="hl-3">);</span><br/><span class="hl-3">};</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-5">callbackB</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">'B'</span><span class="hl-3">);</span><br/><span class="hl-3">};</span><br/><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-4">callbackA</span><span class="hl-3">);</span><br/><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-4">callbackB</span><span class="hl-3">);</span><br/><br/><span class="hl-8">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-8">// Internal listener array at time of emit [callbackA, callbackB]</span><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><br/><span class="hl-8">// Prints:</span><br/><span class="hl-8">// A</span><br/><span class="hl-8">// B</span><br/><br/><span class="hl-8">// callbackB is now removed.</span><br/><span class="hl-8">// Internal listener array [callbackA]</span><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><br/><span class="hl-8">// Prints:</span><br/><span class="hl-8">// A</span>
|
|
226
929
|
</code><button type="button">Copy</button></pre>
|
|
227
930
|
|
|
228
931
|
<p>Because listeners are managed using an internal array, calling this will
|
|
229
|
-
change the position
|
|
932
|
+
change the position indexes of any listener registered <em>after</em> the listener
|
|
230
933
|
being removed. This will not impact the order in which listeners are called,
|
|
231
934
|
but it means that any copies of the listener array as returned by
|
|
232
935
|
the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
|
233
936
|
<p>When a single function has been added as a handler multiple times for a single
|
|
234
937
|
event (as in the example below), <code>removeListener()</code> will remove the most
|
|
235
|
-
recently added instance. In the example the <code>once('ping')</code>
|
|
236
|
-
|
|
938
|
+
recently added instance. In the example the <code>once('ping')</code>
|
|
939
|
+
listener is removed:</p>
|
|
940
|
+
<pre><code class="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-9">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>
|
|
237
941
|
</code><button type="button">Copy</button></pre>
|
|
238
942
|
|
|
239
943
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
240
|
-
</div
|
|
241
|
-
|
|
944
|
+
</div>
|
|
945
|
+
<section class="tsd-panel">
|
|
946
|
+
<h4>Type Parameters</h4>
|
|
947
|
+
<ul class="tsd-type-parameter-list">
|
|
948
|
+
<li><span id="removelistenere"><span class="tsd-kind-type-parameter">E</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li></ul></section>
|
|
949
|
+
<div class="tsd-parameters">
|
|
950
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
951
|
+
<ul class="tsd-parameter-list">
|
|
952
|
+
<li><span><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></span></li>
|
|
953
|
+
<li><span><span class="tsd-kind-parameter">listener</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-type">any</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></span></li></ul></div>
|
|
954
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
955
|
+
<div class="tsd-comment tsd-typography">
|
|
956
|
+
<div class="tsd-tag-since">
|
|
957
|
+
<h4 class="tsd-anchor-link" id="since-14">Since<a href="#since-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.1.26</p>
|
|
958
|
+
</div></div><aside class="tsd-sources">
|
|
959
|
+
<p>Inherited from EventEmitter.removeListener</p>
|
|
960
|
+
<ul>
|
|
961
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:425</li></ul></aside></div></li></ul></section>
|
|
962
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
963
|
+
<h3 class="tsd-anchor-link" id="setmaxlisteners"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setmaxlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
964
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
965
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
966
|
+
<div class="tsd-signature tsd-anchor-link" id="setmaxlisteners-1"><span class="tsd-kind-call-signature">setMaxListeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setmaxlisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
967
|
+
<div class="tsd-description">
|
|
968
|
+
<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
|
|
242
969
|
added for a particular event. This is a useful default that helps finding
|
|
243
970
|
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
|
244
|
-
modified for this specific <code>EventEmitter</code> instance. The value can be set to
|
|
971
|
+
modified for this specific <code>EventEmitter</code> instance. The value can be set to
|
|
972
|
+
<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
|
245
973
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
246
|
-
</div
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
<
|
|
250
|
-
<
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
<
|
|
259
|
-
<
|
|
260
|
-
</
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
<div class="tsd-
|
|
264
|
-
|
|
265
|
-
<p>
|
|
266
|
-
|
|
267
|
-
<
|
|
268
|
-
|
|
269
|
-
<
|
|
270
|
-
</
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
<
|
|
275
|
-
|
|
276
|
-
<
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
<
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
<
|
|
285
|
-
</
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
<
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
<
|
|
299
|
-
<
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
<
|
|
303
|
-
<
|
|
304
|
-
</
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
<div class="tsd-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
<
|
|
316
|
-
<
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
<p>Use the <code>close</code> option to specify an array of event names that will end the iteration:</p>
|
|
320
|
-
<pre><code class="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><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">'close'</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><span class="hl-4">close:</span><span class="hl-3"> [</span><span class="hl-1">'close'</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-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">// the loop will exit after 'close' is emitted</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-1">'done'</span><span class="hl-3">); </span><span class="hl-8">// prints 'done'</span>
|
|
321
|
-
</code><button type="button">Copy</button></pre>
|
|
322
|
-
|
|
323
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type">EventTarget</span></span></li><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">StaticEventEmitterIteratorOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterator</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><p>An <code>AsyncIterator</code> that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
|
|
324
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-24">Since<a href="#since-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v13.6.0, v12.16.0</p>
|
|
325
|
-
</div></div><aside class="tsd-sources"><p>Inherited from EventEmitter.on</p><ul><li>Defined in node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/events.d.ts:275</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="once-2"><code class="tsd-tag">Static</code><span>once</span><a href="#once-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="once-3"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">emitter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">eventName</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><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">,</span><br/><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-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
|
|
326
|
-
event or that is rejected if the <code>EventEmitter</code> emits <code>'error'</code> while waiting.
|
|
327
|
-
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
|
|
328
|
-
given event.</p>
|
|
329
|
-
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
|
330
|
-
semantics and does not listen to the <code>'error'</code> event.</p>
|
|
331
|
-
<pre><code class="js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">once</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-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">'myevent'</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-0">const</span><span class="hl-3"> [</span><span class="hl-7">value</span><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">ee</span><span class="hl-3">, </span><span class="hl-1">'myevent'</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-4">value</span><span class="hl-3">);</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">err</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">Error</span><span class="hl-3">(</span><span class="hl-1">'kaboom'</span><span class="hl-3">);</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">'error'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><br/><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">ee</span><span class="hl-3">, </span><span class="hl-1">'myevent'</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">err</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">'error happened'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">);</span><br/><span class="hl-3">}</span>
|
|
332
|
-
</code><button type="button">Copy</button></pre>
|
|
333
|
-
|
|
334
|
-
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code> is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
|
335
|
-
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
|
336
|
-
special handling:</p>
|
|
337
|
-
<pre><code class="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/><br/><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'error'</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">then</span><span class="hl-3">(([</span><span class="hl-4">err</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">'ok'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">.</span><span class="hl-4">message</span><span class="hl-3">))</span><br/><span class="hl-3"> .</span><span class="hl-5">catch</span><span class="hl-3">((</span><span class="hl-4">err</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">error</span><span class="hl-3">(</span><span class="hl-1">'error'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">.</span><span class="hl-4">message</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">'error'</span><span class="hl-3">, </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">Error</span><span class="hl-3">(</span><span class="hl-1">'boom'</span><span class="hl-3">));</span><br/><br/><span class="hl-8">// Prints: ok boom</span>
|
|
338
|
-
</code><button type="button">Copy</button></pre>
|
|
339
|
-
|
|
340
|
-
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
|
341
|
-
<pre><code class="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>
|
|
342
|
-
</code><button type="button">Copy</button></pre>
|
|
343
|
-
|
|
344
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type">EventEmitter</span></span></li><li><span><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></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">StaticEventEmitterOptions</span></span></li></ul></div><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><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-25">Since<a href="#since-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v11.13.0, v10.16.0</p>
|
|
345
|
-
</div></div><aside class="tsd-sources"><p>Inherited from EventEmitter.once</p><ul><li>Defined in node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/events.d.ts:184</li></ul></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="once-4"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">emitter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventTarget</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">,</span><br/><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-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
|
|
346
|
-
event or that is rejected if the <code>EventEmitter</code> emits <code>'error'</code> while waiting.
|
|
347
|
-
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
|
|
348
|
-
given event.</p>
|
|
349
|
-
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
|
350
|
-
semantics and does not listen to the <code>'error'</code> event.</p>
|
|
351
|
-
<pre><code class="js"><span class="hl-6">import</span><span class="hl-3"> { </span><span class="hl-4">once</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-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">'myevent'</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-0">const</span><span class="hl-3"> [</span><span class="hl-7">value</span><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">ee</span><span class="hl-3">, </span><span class="hl-1">'myevent'</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-4">value</span><span class="hl-3">);</span><br/><br/><span class="hl-0">const</span><span class="hl-3"> </span><span class="hl-7">err</span><span class="hl-3"> = </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">Error</span><span class="hl-3">(</span><span class="hl-1">'kaboom'</span><span class="hl-3">);</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">'error'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">);</span><br/><span class="hl-3">});</span><br/><br/><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">ee</span><span class="hl-3">, </span><span class="hl-1">'myevent'</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">err</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">'error happened'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">);</span><br/><span class="hl-3">}</span>
|
|
352
|
-
</code><button type="button">Copy</button></pre>
|
|
353
|
-
|
|
354
|
-
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code> is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
|
355
|
-
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
|
356
|
-
special handling:</p>
|
|
357
|
-
<pre><code class="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/><br/><span class="hl-5">once</span><span class="hl-3">(</span><span class="hl-4">ee</span><span class="hl-3">, </span><span class="hl-1">'error'</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">then</span><span class="hl-3">(([</span><span class="hl-4">err</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">'ok'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">.</span><span class="hl-4">message</span><span class="hl-3">))</span><br/><span class="hl-3"> .</span><span class="hl-5">catch</span><span class="hl-3">((</span><span class="hl-4">err</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">error</span><span class="hl-3">(</span><span class="hl-1">'error'</span><span class="hl-3">, </span><span class="hl-4">err</span><span class="hl-3">.</span><span class="hl-4">message</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">'error'</span><span class="hl-3">, </span><span class="hl-0">new</span><span class="hl-3"> </span><span class="hl-5">Error</span><span class="hl-3">(</span><span class="hl-1">'boom'</span><span class="hl-3">));</span><br/><br/><span class="hl-8">// Prints: ok boom</span>
|
|
358
|
-
</code><button type="button">Copy</button></pre>
|
|
359
|
-
|
|
360
|
-
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
|
361
|
-
<pre><code class="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>
|
|
362
|
-
</code><button type="button">Copy</button></pre>
|
|
363
|
-
|
|
364
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type">EventTarget</span></span></li><li><span><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">StaticEventEmitterOptions</span></span></li></ul></div><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><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-26">Since<a href="#since-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v11.13.0, v10.16.0</p>
|
|
365
|
-
</div></div><aside class="tsd-sources"><p>Inherited from EventEmitter.once</p><ul><li>Defined in node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/events.d.ts:189</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setmaxlisteners-2"><code class="tsd-tag">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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setmaxlisteners-3"><span class="tsd-kind-call-signature">setMaxListeners</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">EventTarget</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">DefaultEventMap</span><span class="tsd-signature-symbol">></span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setmaxlisteners-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><pre><code class="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>
|
|
366
|
-
</code><button type="button">Copy</button></pre>
|
|
367
|
-
|
|
368
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A non-negative number. The maximum number of listeners per <code>EventTarget</code> event.</p>
|
|
369
|
-
</div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span>: (<span class="tsd-signature-type">EventTarget</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">DefaultEventMap</span><span class="tsd-signature-symbol">></span>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, <code>n</code> is set as the default max for all newly created {EventTarget} and {EventEmitter}
|
|
370
|
-
objects.</p>
|
|
371
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since-27">Since<a href="#since-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v15.4.0</p>
|
|
372
|
-
</div></div><aside class="tsd-sources"><p>Inherited from EventEmitter.setMaxListeners</p><ul><li>Defined in node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/events.d.ts:369</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#capturerejections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>capture<wbr/>Rejections</span></a><a href="#capturerejectionsymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a><a href="#defaultmaxlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a><a href="#errormonitor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error<wbr/>Monitor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#_attachhandlers" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>attach<wbr/>Handlers</span></a><a href="#_buildargoptions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>build<wbr/>Arg<wbr/>Options</span></a><a href="#_closedatabase" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Database</span></a><a href="#_closesocket" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Socket</span></a><a href="#_createlogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>create<wbr/>Logger</span></a><a href="#_getversion" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>get<wbr/>Version</span></a><a href="#_initdb" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>init<wbr/>DB</span></a><a href="#_initialize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>initialize</span></a><a href="#_initlogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>init<wbr/>Logger</span></a><a href="#_onbeforereadyasync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Before<wbr/>Ready<wbr/>Async</span></a><a href="#_onconfigload" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Config<wbr/>Load</span></a><a href="#_onready" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Ready</span></a><a href="#capturerejectionsymbol-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]</span></a><a href="#addlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#attachhandler"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler</span></a><a href="#attachhandlerinstance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler<wbr/>Instance</span></a><a href="#close"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#eventnames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>event<wbr/>Names</span></a><a href="#getcmdlineargs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span></a><a href="#getconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a><a href="#getconfigfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config<wbr/>File<wbr/>Path</span></a><a href="#getconfigfromcliargs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config<wbr/>From<wbr/>CLI<wbr/>Args</span></a><a href="#getdb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>DB</span></a><a href="#getdefaultportforprometheus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Port<wbr/>For<wbr/>Prometheus</span></a><a href="#getlocalconfigfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Local<wbr/>Config<wbr/>File<wbr/>Path</span></a><a href="#getlogger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Logger</span></a><a href="#getmaxlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a><a href="#getname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Name</span></a><a href="#getport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Port</span></a><a href="#getprogram"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Program</span></a><a href="#getrequestsizelimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span></a><a href="#getshard"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Shard</span></a><a href="#gettokenmanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Manager</span></a><a href="#getversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Version</span></a><a href="#isprometheusenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Prometheus<wbr/>Enabled</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listeners</span></a><a href="#loadconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Config</span></a><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a><a href="#prependlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a><a href="#prependoncelistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a><a href="#rawlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a><a href="#removealllisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#removelistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a><a href="#setmaxlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a><a href="#settokenmanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Token<wbr/>Manager</span></a><a href="#shouldlisten"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Listen</span></a><a href="#start"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a><a href="#addabortlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Abort<wbr/>Listener</span></a><a href="#geteventlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Listeners</span></a><a href="#getmaxlisteners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a><a href="#listenercount-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#on-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#once-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a><a href="#setmaxlisteners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
974
|
+
</div>
|
|
975
|
+
<div class="tsd-parameters">
|
|
976
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
977
|
+
<ul class="tsd-parameter-list">
|
|
978
|
+
<li><span><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></span></li></ul></div>
|
|
979
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
980
|
+
<div class="tsd-comment tsd-typography">
|
|
981
|
+
<div class="tsd-tag-since">
|
|
982
|
+
<h4 class="tsd-anchor-link" id="since-15">Since<a href="#since-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>v0.3.5</p>
|
|
983
|
+
</div></div><aside class="tsd-sources">
|
|
984
|
+
<p>Inherited from EventEmitter.setMaxListeners</p>
|
|
985
|
+
<ul>
|
|
986
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:436</li></ul></aside></div></li></ul></section>
|
|
987
|
+
<section class="tsd-panel tsd-member">
|
|
988
|
+
<h3 class="tsd-anchor-link" id="settokenmanager"><span>set<wbr/>Token<wbr/>Manager</span><a href="#settokenmanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
989
|
+
<ul class="tsd-signatures">
|
|
990
|
+
<li class="">
|
|
991
|
+
<div class="tsd-signature tsd-anchor-link" id="settokenmanager-1"><span class="tsd-kind-call-signature">setTokenManager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tokenManager</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><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><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="#settokenmanager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
992
|
+
<div class="tsd-description">
|
|
993
|
+
<div class="tsd-comment tsd-typography"><p>Sets the TokenManager to be used for authentication.</p>
|
|
994
|
+
</div>
|
|
995
|
+
<div class="tsd-parameters">
|
|
996
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
997
|
+
<ul class="tsd-parameter-list">
|
|
998
|
+
<li><span><span class="tsd-kind-parameter">tokenManager</span>: <a href="TokenManager.html" class="tsd-signature-type tsd-kind-class">TokenManager</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tauthtoken">TAuthToken</a><span class="tsd-signature-symbol">></span></span></li></ul></div>
|
|
999
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1000
|
+
<ul>
|
|
1001
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L558">src/Application.ts:558</a></li></ul></aside></div></li></ul></section>
|
|
1002
|
+
<section class="tsd-panel tsd-member">
|
|
1003
|
+
<h3 class="tsd-anchor-link" id="shouldlisten"><span>should<wbr/>Listen</span><a href="#shouldlisten" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1004
|
+
<ul class="tsd-signatures">
|
|
1005
|
+
<li class="">
|
|
1006
|
+
<div class="tsd-signature tsd-anchor-link" id="shouldlisten-1"><span class="tsd-kind-call-signature">shouldListen</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#shouldlisten-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1007
|
+
<div class="tsd-description">
|
|
1008
|
+
<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>
|
|
1009
|
+
<aside class="tsd-sources">
|
|
1010
|
+
<ul>
|
|
1011
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L543">src/Application.ts:543</a></li></ul></aside></div></li></ul></section>
|
|
1012
|
+
<section class="tsd-panel tsd-member">
|
|
1013
|
+
<h3 class="tsd-anchor-link" id="start"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1014
|
+
<ul class="tsd-signatures">
|
|
1015
|
+
<li class="">
|
|
1016
|
+
<div class="tsd-signature tsd-anchor-link" id="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-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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1017
|
+
<div class="tsd-description">
|
|
1018
|
+
<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">
|
|
1019
|
+
<ul>
|
|
1020
|
+
<li>Defined in <a href="https://github.com/breautek/storm/blob/6e6b27ecec41492bd73a62d2ee13b2ba7371befb/src/Application.ts#L128">src/Application.ts:128</a></li></ul></aside></div></li></ul></section></section></details></div>
|
|
1021
|
+
<div class="col-sidebar">
|
|
1022
|
+
<div class="page-menu">
|
|
1023
|
+
<div class="tsd-navigation settings">
|
|
1024
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1025
|
+
<h3>Settings</h3></summary>
|
|
1026
|
+
<div class="tsd-accordion-details">
|
|
1027
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
1028
|
+
<ul id="tsd-filter-options">
|
|
1029
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
1030
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
1031
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
1032
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1033
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1034
|
+
<h3>On This Page</h3></summary>
|
|
1035
|
+
<div class="tsd-accordion-details">
|
|
1036
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
1037
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
1038
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
1039
|
+
<div><a href="#_attachhandlers" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>attach<wbr/>Handlers</span></a><a href="#_buildargoptions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>build<wbr/>Arg<wbr/>Options</span></a><a href="#_closedatabase" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Database</span></a><a href="#_closesocket" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>close<wbr/>Socket</span></a><a href="#_createlogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>create<wbr/>Logger</span></a><a href="#_getversion" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>get<wbr/>Version</span></a><a href="#_initdb" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>init<wbr/>DB</span></a><a href="#_initialize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>initialize</span></a><a href="#_initlogger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>init<wbr/>Logger</span></a><a href="#_onbeforereadyasync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Before<wbr/>Ready<wbr/>Async</span></a><a href="#_onconfigload" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Config<wbr/>Load</span></a><a href="#_onready" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_<wbr/>on<wbr/>Ready</span></a><a href="#capturerejectionsymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]</span></a><a href="#addlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#attachhandler"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler</span></a><a href="#attachhandlerinstance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach<wbr/>Handler<wbr/>Instance</span></a><a href="#close"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#eventnames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>event<wbr/>Names</span></a><a href="#getcmdlineargs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cmd<wbr/>Line<wbr/>Args</span></a><a href="#getconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a><a href="#getconfigfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config<wbr/>File<wbr/>Path</span></a><a href="#getconfigfromcliargs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config<wbr/>From<wbr/>CLI<wbr/>Args</span></a><a href="#getdb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>DB</span></a><a href="#getdefaultportforprometheus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default<wbr/>Port<wbr/>For<wbr/>Prometheus</span></a><a href="#getlocalconfigfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Local<wbr/>Config<wbr/>File<wbr/>Path</span></a><a href="#getlogger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Logger</span></a><a href="#getmaxlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a><a href="#getname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Name</span></a><a href="#getport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Port</span></a><a href="#getprogram"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Program</span></a><a href="#getrequestsizelimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Request<wbr/>Size<wbr/>Limit</span></a><a href="#getshard"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Shard</span></a><a href="#gettokenmanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Manager</span></a><a href="#getversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Version</span></a><a href="#isprometheusenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Prometheus<wbr/>Enabled</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listeners</span></a><a href="#loadconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Config</span></a><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a><a href="#prependlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a><a href="#prependoncelistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a><a href="#rawlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a><a href="#removealllisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#removelistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a><a href="#setmaxlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a><a href="#settokenmanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Token<wbr/>Manager</span></a><a href="#shouldlisten"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Listen</span></a><a href="#start"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a></div></details></div></details></div>
|
|
1040
|
+
<div class="site-menu">
|
|
1041
|
+
<nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a>
|
|
1042
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
1043
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
1044
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
1045
|
+
<div class="overlay"></div></body></html>
|