doc, typings: events.once accepts symbol event type

PR-URL: #53542 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
nodejs · Aug 19, 2024 · 4187b81 · 4187b81
1 parent c7e4c3d
commit 4187b81
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/api/events.md b/doc/api/events.md
@@ -1333,7 +1333,7 @@ changes:
 -->
 
 * `emitter` {EventEmitter}
-* `name` {string}
+* `name` {string|symbol}
 * `options` {Object}
   * `signal` {AbortSignal} Can be used to cancel waiting for the event.
 * Returns: {Promise}

diff --git a/lib/events.js b/lib/events.js
@@ -966,7 +966,7 @@ function getMaxListeners(emitterOrTarget) {
  * Creates a `Promise` that is fulfilled when the emitter
  * emits the given event.
  * @param {EventEmitter} emitter
- * @param {string} name
+ * @param {string | symbol} name
  * @param {{ signal: AbortSignal; }} [options]
  * @returns {Promise}
  */