@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,9 +1,40 @@
|
|
|
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>Part | @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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@breautek/storm</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/formidable.html">formidable</a></li><li><a href="" aria-current="page">Part</a></li></ul><h1>Interface Part</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Part</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#mimetype">mimetype</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#originalfilename">originalFilename</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#capturerejectionsymbol-1">"[captureRejectionSymbol]"</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#capturerejectionsymbolk">K</a><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">AnyRest</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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#addlistener-1">addListener</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#addlistenerk">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#compose-1">compose</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#composet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stream</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ComposeFnParam</span><br/> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#composet">T</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#composet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#composet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AbortSignal</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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#composet">T</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#emit-1">emit</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitk">K</a><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-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AnyRest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#eventnames-1">eventNames</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getmaxlisteners-1">getMaxListeners</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listenercount-1">listenerCount</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountk">K</a><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-kind-parameter">listener</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listeners-1">listeners</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#listenersk">K</a><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">Function</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#off-1">off</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#offk">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#on-1">on</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#onk">K</a><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-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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#once-1">once</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncek">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#pipe-1">pipe</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prependlistener-1">prependListener</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#prependlistenerk">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prependoncelistener-1">prependOnceListener</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#prependoncelistenerk">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#rawlisteners-1">rawListeners</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#rawlistenersk">K</a><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">Function</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#removealllisteners-1">removeAllListeners</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#removelistener-1">removeListener</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#removelistenerk">K</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setmaxlisteners-1">setMaxListeners</a><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><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2324"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Stream</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Part</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/@types+formidable@3.5.1/node_modules/@types/formidable/index.d.ts:208</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#mimetype" class="tsd-index-link 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>mimetype</span></a>
|
|
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>Part | @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="../modules/formidable.html">formidable</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">Part</a></li></ul>
|
|
13
|
+
<h1>Interface Part</h1></div>
|
|
14
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Part</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#mimetype">mimetype</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#originalfilename">originalFilename</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#capturerejectionsymbol-1">"[captureRejectionSymbol]"</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#addlistener-1">addListener</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#emit-1">emit</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#eventnames-1">eventNames</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getmaxlisteners-1">getMaxListeners</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listenercount-1">listenerCount</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#listeners-1">listeners</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#off-1">off</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#on-1">on</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#once-1">once</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#pipe-1">pipe</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PipeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prependlistener-1">prependListener</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prependoncelistener-1">prependOnceListener</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#rawlisteners-1">rawListeners</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#removealllisteners-1">removeAllListeners</a><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><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-type">this</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#removelistener-1">removeListener</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setmaxlisteners-1">setMaxListeners</a><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><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
15
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="2289">
|
|
16
|
+
<h4>Hierarchy</h4>
|
|
17
|
+
<ul class="tsd-hierarchy">
|
|
18
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Stream</span>
|
|
19
|
+
<ul class="tsd-hierarchy">
|
|
20
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Part</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Defined in node_modules/.pnpm/@types+formidable@3.5.1/node_modules/@types/formidable/index.d.ts:208</li></ul></aside>
|
|
23
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
24
|
+
<section class="tsd-panel tsd-index-panel">
|
|
25
|
+
<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>
|
|
26
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
27
|
+
<div class="tsd-accordion-details">
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" 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>
|
|
30
|
+
<div class="tsd-index-list"><a href="#mimetype" class="tsd-index-link 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>mimetype</span></a>
|
|
2
31
|
<a href="#name" class="tsd-index-link 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>name</span></a>
|
|
3
32
|
<a href="#originalfilename" class="tsd-index-link 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>original<wbr/>Filename</span></a>
|
|
4
|
-
</div></section
|
|
33
|
+
</div></section>
|
|
34
|
+
<section class="tsd-index-section">
|
|
35
|
+
<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>
|
|
36
|
+
<div class="tsd-index-list"><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>
|
|
5
37
|
<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>
|
|
6
|
-
<a href="#compose" 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>compose</span></a>
|
|
7
38
|
<a href="#emit" 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>emit</span></a>
|
|
8
39
|
<a href="#eventnames" 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>event<wbr/>Names</span></a>
|
|
9
40
|
<a href="#getmaxlisteners" 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>get<wbr/>Max<wbr/>Listeners</span></a>
|
|
@@ -19,100 +50,476 @@
|
|
|
19
50
|
<a href="#removealllisteners" 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>remove<wbr/>All<wbr/>Listeners</span></a>
|
|
20
51
|
<a href="#removelistener" 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>remove<wbr/>Listener</span></a>
|
|
21
52
|
<a href="#setmaxlisteners" 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>set<wbr/>Max<wbr/>Listeners</span></a>
|
|
22
|
-
</div></section></div></details></section></section
|
|
23
|
-
|
|
24
|
-
|
|
53
|
+
</div></section></div></details></section></section>
|
|
54
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><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>
|
|
55
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-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>
|
|
56
|
+
<section>
|
|
57
|
+
<section class="tsd-panel tsd-member tsd-is-external">
|
|
58
|
+
<h3 class="tsd-anchor-link" id="mimetype"><span>mimetype</span><a href="#mimetype" 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>
|
|
59
|
+
<div class="tsd-signature"><span class="tsd-kind-property">mimetype</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
60
|
+
<ul>
|
|
61
|
+
<li>Defined in node_modules/.pnpm/@types+formidable@3.5.1/node_modules/@types/formidable/index.d.ts:211</li></ul></aside></section>
|
|
62
|
+
<section class="tsd-panel tsd-member tsd-is-external">
|
|
63
|
+
<h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" 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>
|
|
64
|
+
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
65
|
+
<ul>
|
|
66
|
+
<li>Defined in node_modules/.pnpm/@types+formidable@3.5.1/node_modules/@types/formidable/index.d.ts:209</li></ul></aside></section>
|
|
67
|
+
<section class="tsd-panel tsd-member tsd-is-external">
|
|
68
|
+
<h3 class="tsd-anchor-link" id="originalfilename"><span>original<wbr/>Filename</span><a href="#originalfilename" 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>
|
|
69
|
+
<div class="tsd-signature"><span class="tsd-kind-property">originalFilename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
70
|
+
<ul>
|
|
71
|
+
<li>Defined in node_modules/.pnpm/@types+formidable@3.5.1/node_modules/@types/formidable/index.d.ts:210</li></ul></aside></section></section></details>
|
|
72
|
+
<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>
|
|
73
|
+
<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>
|
|
74
|
+
<section>
|
|
75
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
76
|
+
<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>
|
|
77
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
78
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
79
|
+
<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>
|
|
80
|
+
<div class="tsd-description">
|
|
81
|
+
<div class="tsd-comment tsd-typography"><p>The <code>Symbol.for('nodejs.rejection')</code> method is called in case a
|
|
82
|
+
promise rejection happens when emitting an event and
|
|
83
|
+
<code>captureRejections</code> is enabled on the emitter.
|
|
84
|
+
It is possible to use <code>events.captureRejectionSymbol</code> in
|
|
85
|
+
place of <code>Symbol.for('nodejs.rejection')</code>.</p>
|
|
86
|
+
<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>
|
|
87
|
+
</code><button type="button">Copy</button></pre>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
<div class="tsd-parameters">
|
|
91
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
92
|
+
<ul class="tsd-parameter-list">
|
|
93
|
+
<li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">Error</span></span></li>
|
|
94
|
+
<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>
|
|
95
|
+
<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>
|
|
96
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
97
|
+
<div class="tsd-comment tsd-typography">
|
|
98
|
+
<div class="tsd-tag-since">
|
|
99
|
+
<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>
|
|
100
|
+
</div></div><aside class="tsd-sources">
|
|
101
|
+
<p>Inherited from Stream.[captureRejectionSymbol]</p>
|
|
102
|
+
<ul>
|
|
103
|
+
<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>
|
|
104
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
105
|
+
<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>
|
|
106
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
107
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
108
|
+
<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>
|
|
109
|
+
<div class="tsd-description">
|
|
110
|
+
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
|
|
111
|
+
</div>
|
|
112
|
+
<section class="tsd-panel">
|
|
113
|
+
<h4>Type Parameters</h4>
|
|
114
|
+
<ul class="tsd-type-parameter-list">
|
|
115
|
+
<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>
|
|
116
|
+
<div class="tsd-parameters">
|
|
117
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
118
|
+
<ul class="tsd-parameter-list">
|
|
119
|
+
<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>
|
|
120
|
+
<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>
|
|
121
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
122
|
+
<div class="tsd-comment tsd-typography">
|
|
123
|
+
<div class="tsd-tag-since">
|
|
124
|
+
<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>
|
|
125
|
+
</div></div><aside class="tsd-sources">
|
|
126
|
+
<p>Inherited from Stream.addListener</p>
|
|
127
|
+
<ul>
|
|
128
|
+
<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>
|
|
129
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
130
|
+
<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>
|
|
131
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
132
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
133
|
+
<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>
|
|
134
|
+
<div class="tsd-description">
|
|
135
|
+
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named
|
|
136
|
+
<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
|
25
137
|
to each.</p>
|
|
26
138
|
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
|
27
|
-
<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-
|
|
139
|
+
<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>
|
|
28
140
|
</code><button type="button">Copy</button></pre>
|
|
29
141
|
|
|
30
|
-
</div
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
<
|
|
142
|
+
</div>
|
|
143
|
+
<section class="tsd-panel">
|
|
144
|
+
<h4>Type Parameters</h4>
|
|
145
|
+
<ul class="tsd-type-parameter-list">
|
|
146
|
+
<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>
|
|
147
|
+
<div class="tsd-parameters">
|
|
148
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
149
|
+
<ul class="tsd-parameter-list">
|
|
150
|
+
<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>
|
|
151
|
+
<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>
|
|
152
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
153
|
+
<div class="tsd-comment tsd-typography">
|
|
154
|
+
<div class="tsd-tag-since">
|
|
155
|
+
<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>
|
|
156
|
+
</div></div><aside class="tsd-sources">
|
|
157
|
+
<p>Inherited from Stream.emit</p>
|
|
158
|
+
<ul>
|
|
159
|
+
<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>
|
|
160
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
161
|
+
<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>
|
|
162
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
163
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
164
|
+
<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>
|
|
165
|
+
<div class="tsd-description">
|
|
166
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
|
167
|
+
listeners.</p>
|
|
168
|
+
<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>
|
|
34
169
|
</code><button type="button">Copy</button></pre>
|
|
35
170
|
|
|
36
|
-
</div
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
171
|
+
</div>
|
|
172
|
+
<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>
|
|
173
|
+
<div class="tsd-comment tsd-typography">
|
|
174
|
+
<div class="tsd-tag-since">
|
|
175
|
+
<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>
|
|
176
|
+
</div></div><aside class="tsd-sources">
|
|
177
|
+
<p>Inherited from Stream.eventNames</p>
|
|
178
|
+
<ul>
|
|
179
|
+
<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>
|
|
180
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
181
|
+
<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>
|
|
182
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
183
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
184
|
+
<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>
|
|
185
|
+
<div class="tsd-description">
|
|
186
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
|
187
|
+
set by <code>emitter.setMaxListeners(n)</code> or defaults to
|
|
188
|
+
<code>events.defaultMaxListeners</code>.</p>
|
|
189
|
+
</div>
|
|
190
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
191
|
+
<div class="tsd-comment tsd-typography">
|
|
192
|
+
<div class="tsd-tag-since">
|
|
193
|
+
<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>
|
|
194
|
+
</div></div><aside class="tsd-sources">
|
|
195
|
+
<p>Inherited from Stream.getMaxListeners</p>
|
|
196
|
+
<ul>
|
|
197
|
+
<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>
|
|
198
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
199
|
+
<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>
|
|
200
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
201
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
202
|
+
<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>
|
|
203
|
+
<div class="tsd-description">
|
|
204
|
+
<div class="tsd-comment tsd-typography"><p>Returns the number of listeners listening for the event named <code>eventName</code>.
|
|
41
205
|
If <code>listener</code> is provided, it will return how many times the listener is found
|
|
42
206
|
in the list of the listeners of the event.</p>
|
|
43
|
-
</div
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
207
|
+
</div>
|
|
208
|
+
<section class="tsd-panel">
|
|
209
|
+
<h4>Type Parameters</h4>
|
|
210
|
+
<ul class="tsd-type-parameter-list">
|
|
211
|
+
<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>
|
|
212
|
+
<div class="tsd-parameters">
|
|
213
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
214
|
+
<ul class="tsd-parameter-list">
|
|
215
|
+
<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>
|
|
216
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
|
217
|
+
</div></li>
|
|
218
|
+
<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>
|
|
219
|
+
<div class="tsd-comment tsd-typography"><p>The event handler function</p>
|
|
220
|
+
</div></li></ul></div>
|
|
221
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
222
|
+
<div class="tsd-comment tsd-typography">
|
|
223
|
+
<div class="tsd-tag-since">
|
|
224
|
+
<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>
|
|
225
|
+
</div></div><aside class="tsd-sources">
|
|
226
|
+
<p>Inherited from Stream.listenerCount</p>
|
|
227
|
+
<ul>
|
|
228
|
+
<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>
|
|
229
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
230
|
+
<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>
|
|
231
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
232
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
233
|
+
<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>
|
|
234
|
+
<div class="tsd-description">
|
|
235
|
+
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
47
236
|
<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>
|
|
48
237
|
</code><button type="button">Copy</button></pre>
|
|
49
238
|
|
|
50
|
-
</div
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
<
|
|
239
|
+
</div>
|
|
240
|
+
<section class="tsd-panel">
|
|
241
|
+
<h4>Type Parameters</h4>
|
|
242
|
+
<ul class="tsd-type-parameter-list">
|
|
243
|
+
<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>
|
|
244
|
+
<div class="tsd-parameters">
|
|
245
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
246
|
+
<ul class="tsd-parameter-list">
|
|
247
|
+
<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>
|
|
248
|
+
<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>
|
|
249
|
+
<div class="tsd-comment tsd-typography">
|
|
250
|
+
<div class="tsd-tag-since">
|
|
251
|
+
<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>
|
|
252
|
+
</div></div><aside class="tsd-sources">
|
|
253
|
+
<p>Inherited from Stream.listeners</p>
|
|
254
|
+
<ul>
|
|
255
|
+
<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>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
257
|
+
<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>
|
|
258
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
259
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
260
|
+
<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>
|
|
261
|
+
<div class="tsd-description">
|
|
262
|
+
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
|
263
|
+
</div>
|
|
264
|
+
<section class="tsd-panel">
|
|
265
|
+
<h4>Type Parameters</h4>
|
|
266
|
+
<ul class="tsd-type-parameter-list">
|
|
267
|
+
<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>
|
|
268
|
+
<div class="tsd-parameters">
|
|
269
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
270
|
+
<ul class="tsd-parameter-list">
|
|
271
|
+
<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>
|
|
272
|
+
<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>
|
|
273
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
274
|
+
<div class="tsd-comment tsd-typography">
|
|
275
|
+
<div class="tsd-tag-since">
|
|
276
|
+
<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>
|
|
277
|
+
</div></div><aside class="tsd-sources">
|
|
278
|
+
<p>Inherited from Stream.off</p>
|
|
279
|
+
<ul>
|
|
280
|
+
<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>
|
|
281
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
282
|
+
<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>
|
|
283
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
284
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
285
|
+
<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>
|
|
286
|
+
<div class="tsd-description">
|
|
287
|
+
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the end of the listeners array for the
|
|
288
|
+
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
289
|
+
already been added. Multiple calls passing the same combination of <code>eventName</code>
|
|
290
|
+
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
291
|
+
times.</p>
|
|
57
292
|
<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>
|
|
58
293
|
</code><button type="button">Copy</button></pre>
|
|
59
294
|
|
|
60
295
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
61
|
-
<p>By default, event listeners are invoked in the order they are added. The
|
|
296
|
+
<p>By default, event listeners are invoked in the order they are added. The
|
|
297
|
+
<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
|
62
298
|
event listener to the beginning of the listeners array.</p>
|
|
63
|
-
<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-
|
|
299
|
+
<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>
|
|
64
300
|
</code><button type="button">Copy</button></pre>
|
|
65
301
|
|
|
66
|
-
</div
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
302
|
+
</div>
|
|
303
|
+
<section class="tsd-panel">
|
|
304
|
+
<h4>Type Parameters</h4>
|
|
305
|
+
<ul class="tsd-type-parameter-list">
|
|
306
|
+
<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>
|
|
307
|
+
<div class="tsd-parameters">
|
|
308
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
309
|
+
<ul class="tsd-parameter-list">
|
|
310
|
+
<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>
|
|
311
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
312
|
+
</div></li>
|
|
313
|
+
<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>
|
|
314
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
315
|
+
</div></li></ul></div>
|
|
316
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
317
|
+
<div class="tsd-comment tsd-typography">
|
|
318
|
+
<div class="tsd-tag-since">
|
|
319
|
+
<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>
|
|
320
|
+
</div></div><aside class="tsd-sources">
|
|
321
|
+
<p>Inherited from Stream.on</p>
|
|
322
|
+
<ul>
|
|
323
|
+
<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>
|
|
324
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
325
|
+
<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>
|
|
326
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
327
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
328
|
+
<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>
|
|
329
|
+
<div class="tsd-description">
|
|
330
|
+
<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
|
|
70
331
|
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
|
71
332
|
<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>
|
|
72
333
|
</code><button type="button">Copy</button></pre>
|
|
73
334
|
|
|
74
335
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
75
|
-
<p>By default, event listeners are invoked in the order they are added. The
|
|
336
|
+
<p>By default, event listeners are invoked in the order they are added. The
|
|
337
|
+
<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
|
76
338
|
event listener to the beginning of the listeners array.</p>
|
|
77
|
-
<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-
|
|
339
|
+
<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>
|
|
78
340
|
</code><button type="button">Copy</button></pre>
|
|
79
341
|
|
|
80
|
-
</div
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
342
|
+
</div>
|
|
343
|
+
<section class="tsd-panel">
|
|
344
|
+
<h4>Type Parameters</h4>
|
|
345
|
+
<ul class="tsd-type-parameter-list">
|
|
346
|
+
<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>
|
|
347
|
+
<div class="tsd-parameters">
|
|
348
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
349
|
+
<ul class="tsd-parameter-list">
|
|
350
|
+
<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>
|
|
351
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
352
|
+
</div></li>
|
|
353
|
+
<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>
|
|
354
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
355
|
+
</div></li></ul></div>
|
|
356
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
357
|
+
<div class="tsd-comment tsd-typography">
|
|
358
|
+
<div class="tsd-tag-since">
|
|
359
|
+
<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>
|
|
360
|
+
</div></div><aside class="tsd-sources">
|
|
361
|
+
<p>Inherited from Stream.once</p>
|
|
362
|
+
<ul>
|
|
363
|
+
<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>
|
|
364
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
365
|
+
<h3 class="tsd-anchor-link" id="pipe"><span>pipe</span><a href="#pipe" 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>
|
|
366
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
367
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
368
|
+
<div class="tsd-signature tsd-anchor-link" id="pipe-1"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PipeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a><a href="#pipe-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>
|
|
369
|
+
<div class="tsd-description">
|
|
370
|
+
<section class="tsd-panel">
|
|
371
|
+
<h4>Type Parameters</h4>
|
|
372
|
+
<ul class="tsd-type-parameter-list">
|
|
373
|
+
<li><span id="pipet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">WritableStream</span></span></li></ul></section>
|
|
374
|
+
<div class="tsd-parameters">
|
|
375
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
376
|
+
<ul class="tsd-parameter-list">
|
|
377
|
+
<li><span><span class="tsd-kind-parameter">destination</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a></span></li>
|
|
378
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PipeOptions</span></span></li></ul></div>
|
|
379
|
+
<h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#pipet">T</a></h4>
|
|
380
|
+
<div class="tsd-comment tsd-typography">
|
|
381
|
+
<div class="tsd-tag-since">
|
|
382
|
+
<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>v0.9.4</p>
|
|
383
|
+
</div></div><aside class="tsd-sources">
|
|
384
|
+
<p>Inherited from Stream.pipe</p>
|
|
385
|
+
<ul>
|
|
386
|
+
<li>Defined in node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/stream.d.ts:11</li></ul></aside></div></li></ul></section>
|
|
387
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
388
|
+
<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>
|
|
389
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
390
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
391
|
+
<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>
|
|
392
|
+
<div class="tsd-description">
|
|
393
|
+
<div class="tsd-comment tsd-typography"><p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
|
84
394
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
85
395
|
already been added. Multiple calls passing the same combination of <code>eventName</code>
|
|
86
|
-
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
396
|
+
and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
397
|
+
times.</p>
|
|
87
398
|
<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>
|
|
88
399
|
</code><button type="button">Copy</button></pre>
|
|
89
400
|
|
|
90
401
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
91
|
-
</div
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
402
|
+
</div>
|
|
403
|
+
<section class="tsd-panel">
|
|
404
|
+
<h4>Type Parameters</h4>
|
|
405
|
+
<ul class="tsd-type-parameter-list">
|
|
406
|
+
<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>
|
|
407
|
+
<div class="tsd-parameters">
|
|
408
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
409
|
+
<ul class="tsd-parameter-list">
|
|
410
|
+
<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>
|
|
411
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
412
|
+
</div></li>
|
|
413
|
+
<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>
|
|
414
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
415
|
+
</div></li></ul></div>
|
|
416
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
417
|
+
<div class="tsd-comment tsd-typography">
|
|
418
|
+
<div class="tsd-tag-since">
|
|
419
|
+
<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>
|
|
420
|
+
</div></div><aside class="tsd-sources">
|
|
421
|
+
<p>Inherited from Stream.prependListener</p>
|
|
422
|
+
<ul>
|
|
423
|
+
<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>
|
|
424
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
425
|
+
<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>
|
|
426
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
427
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
428
|
+
<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>
|
|
429
|
+
<div class="tsd-description">
|
|
430
|
+
<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
|
|
431
|
+
<em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
|
95
432
|
listener is removed, and then invoked.</p>
|
|
96
433
|
<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>
|
|
97
434
|
</code><button type="button">Copy</button></pre>
|
|
98
435
|
|
|
99
436
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
100
|
-
</div
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
437
|
+
</div>
|
|
438
|
+
<section class="tsd-panel">
|
|
439
|
+
<h4>Type Parameters</h4>
|
|
440
|
+
<ul class="tsd-type-parameter-list">
|
|
441
|
+
<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>
|
|
442
|
+
<div class="tsd-parameters">
|
|
443
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
444
|
+
<ul class="tsd-parameter-list">
|
|
445
|
+
<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>
|
|
446
|
+
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
|
447
|
+
</div></li>
|
|
448
|
+
<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>
|
|
449
|
+
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
|
450
|
+
</div></li></ul></div>
|
|
451
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
452
|
+
<div class="tsd-comment tsd-typography">
|
|
453
|
+
<div class="tsd-tag-since">
|
|
454
|
+
<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>v6.0.0</p>
|
|
455
|
+
</div></div><aside class="tsd-sources">
|
|
456
|
+
<p>Inherited from Stream.prependOnceListener</p>
|
|
457
|
+
<ul>
|
|
458
|
+
<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>
|
|
459
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
460
|
+
<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>
|
|
461
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
462
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
463
|
+
<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>
|
|
464
|
+
<div class="tsd-description">
|
|
465
|
+
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
|
104
466
|
including any wrappers (such as those created by <code>.once()</code>).</p>
|
|
105
|
-
<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-
|
|
467
|
+
<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>
|
|
106
468
|
</code><button type="button">Copy</button></pre>
|
|
107
469
|
|
|
108
|
-
</div
|
|
109
|
-
|
|
470
|
+
</div>
|
|
471
|
+
<section class="tsd-panel">
|
|
472
|
+
<h4>Type Parameters</h4>
|
|
473
|
+
<ul class="tsd-type-parameter-list">
|
|
474
|
+
<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>
|
|
475
|
+
<div class="tsd-parameters">
|
|
476
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
477
|
+
<ul class="tsd-parameter-list">
|
|
478
|
+
<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>
|
|
479
|
+
<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>
|
|
480
|
+
<div class="tsd-comment tsd-typography">
|
|
481
|
+
<div class="tsd-tag-since">
|
|
482
|
+
<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>v9.4.0</p>
|
|
483
|
+
</div></div><aside class="tsd-sources">
|
|
484
|
+
<p>Inherited from Stream.rawListeners</p>
|
|
485
|
+
<ul>
|
|
486
|
+
<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>
|
|
487
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
488
|
+
<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>
|
|
489
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
490
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
491
|
+
<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>
|
|
492
|
+
<div class="tsd-description">
|
|
493
|
+
<div class="tsd-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
|
110
494
|
<p>It is bad practice to remove listeners added elsewhere in the code,
|
|
111
495
|
particularly when the <code>EventEmitter</code> instance was created by some other
|
|
112
496
|
component or module (e.g. sockets or file streams).</p>
|
|
113
497
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
114
|
-
</div
|
|
115
|
-
|
|
498
|
+
</div>
|
|
499
|
+
<section class="tsd-panel">
|
|
500
|
+
<h4>Type Parameters</h4>
|
|
501
|
+
<ul class="tsd-type-parameter-list">
|
|
502
|
+
<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>
|
|
503
|
+
<div class="tsd-parameters">
|
|
504
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
505
|
+
<ul class="tsd-parameter-list">
|
|
506
|
+
<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>
|
|
507
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
508
|
+
<div class="tsd-comment tsd-typography">
|
|
509
|
+
<div class="tsd-tag-since">
|
|
510
|
+
<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>
|
|
511
|
+
</div></div><aside class="tsd-sources">
|
|
512
|
+
<p>Inherited from Stream.removeAllListeners</p>
|
|
513
|
+
<ul>
|
|
514
|
+
<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>
|
|
515
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
516
|
+
<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>
|
|
517
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
518
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
519
|
+
<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>
|
|
520
|
+
<div class="tsd-description">
|
|
521
|
+
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named
|
|
522
|
+
<code>eventName</code>.</p>
|
|
116
523
|
<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>
|
|
117
524
|
</code><button type="button">Copy</button></pre>
|
|
118
525
|
|
|
@@ -121,28 +528,91 @@ listener array. If any single listener has been added multiple times to the
|
|
|
121
528
|
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
|
|
122
529
|
called multiple times to remove each instance.</p>
|
|
123
530
|
<p>Once an event is emitted, all listeners attached to it at the
|
|
124
|
-
time of emitting are called in order. This implies that any
|
|
125
|
-
|
|
126
|
-
<
|
|
531
|
+
time of emitting are called in order. This implies that any
|
|
532
|
+
<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and
|
|
533
|
+
<em>before</em> the last listener finishes execution will not remove them from
|
|
534
|
+
<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
|
535
|
+
<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>
|
|
127
536
|
</code><button type="button">Copy</button></pre>
|
|
128
537
|
|
|
129
538
|
<p>Because listeners are managed using an internal array, calling this will
|
|
130
|
-
change the position
|
|
539
|
+
change the position indexes of any listener registered <em>after</em> the listener
|
|
131
540
|
being removed. This will not impact the order in which listeners are called,
|
|
132
541
|
but it means that any copies of the listener array as returned by
|
|
133
542
|
the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
|
134
543
|
<p>When a single function has been added as a handler multiple times for a single
|
|
135
544
|
event (as in the example below), <code>removeListener()</code> will remove the most
|
|
136
|
-
recently added instance. In the example the <code>once('ping')</code>
|
|
137
|
-
|
|
545
|
+
recently added instance. In the example the <code>once('ping')</code>
|
|
546
|
+
listener is removed:</p>
|
|
547
|
+
<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>
|
|
138
548
|
</code><button type="button">Copy</button></pre>
|
|
139
549
|
|
|
140
550
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
141
|
-
</div
|
|
142
|
-
|
|
551
|
+
</div>
|
|
552
|
+
<section class="tsd-panel">
|
|
553
|
+
<h4>Type Parameters</h4>
|
|
554
|
+
<ul class="tsd-type-parameter-list">
|
|
555
|
+
<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>
|
|
556
|
+
<div class="tsd-parameters">
|
|
557
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
558
|
+
<ul class="tsd-parameter-list">
|
|
559
|
+
<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>
|
|
560
|
+
<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>
|
|
561
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
562
|
+
<div class="tsd-comment tsd-typography">
|
|
563
|
+
<div class="tsd-tag-since">
|
|
564
|
+
<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.1.26</p>
|
|
565
|
+
</div></div><aside class="tsd-sources">
|
|
566
|
+
<p>Inherited from Stream.removeListener</p>
|
|
567
|
+
<ul>
|
|
568
|
+
<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>
|
|
569
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
570
|
+
<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>
|
|
571
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
572
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
573
|
+
<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>
|
|
574
|
+
<div class="tsd-description">
|
|
575
|
+
<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
|
|
143
576
|
added for a particular event. This is a useful default that helps finding
|
|
144
577
|
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
|
145
|
-
modified for this specific <code>EventEmitter</code> instance. The value can be set to
|
|
578
|
+
modified for this specific <code>EventEmitter</code> instance. The value can be set to
|
|
579
|
+
<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
|
146
580
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
147
|
-
</div
|
|
148
|
-
|
|
581
|
+
</div>
|
|
582
|
+
<div class="tsd-parameters">
|
|
583
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
584
|
+
<ul class="tsd-parameter-list">
|
|
585
|
+
<li><span><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></span></li></ul></div>
|
|
586
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
|
587
|
+
<div class="tsd-comment tsd-typography">
|
|
588
|
+
<div class="tsd-tag-since">
|
|
589
|
+
<h4 class="tsd-anchor-link" id="since-16">Since<a href="#since-16" 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>
|
|
590
|
+
</div></div><aside class="tsd-sources">
|
|
591
|
+
<p>Inherited from Stream.setMaxListeners</p>
|
|
592
|
+
<ul>
|
|
593
|
+
<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></section></details></div>
|
|
594
|
+
<div class="col-sidebar">
|
|
595
|
+
<div class="page-menu">
|
|
596
|
+
<div class="tsd-navigation settings">
|
|
597
|
+
<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>
|
|
598
|
+
<h3>Settings</h3></summary>
|
|
599
|
+
<div class="tsd-accordion-details">
|
|
600
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
601
|
+
<ul id="tsd-filter-options">
|
|
602
|
+
<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>
|
|
603
|
+
<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>
|
|
604
|
+
<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>
|
|
605
|
+
<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>
|
|
606
|
+
<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>
|
|
607
|
+
<h3>On This Page</h3></summary>
|
|
608
|
+
<div class="tsd-accordion-details">
|
|
609
|
+
<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>
|
|
610
|
+
<div><a href="#mimetype" class="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>mimetype</span></a><a href="#name" class="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>name</span></a><a href="#originalfilename" class="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>original<wbr/>Filename</span></a></div></details>
|
|
611
|
+
<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>
|
|
612
|
+
<div><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="#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="#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="#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="#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="#pipe" 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>pipe</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></div></details></div></details></div>
|
|
613
|
+
<div class="site-menu">
|
|
614
|
+
<nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a>
|
|
615
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
616
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
617
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
618
|
+
<div class="overlay"></div></body></html>
|