@types/node 20.14.4 → 20.14.5

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Mon, 17 Jun 2024 23:07:28 GMT
+ * Last updated: Tue, 18 Jun 2024 06:37:41 GMT
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
 
 # Credits

node/events.d.ts

@@ -98,6 +98,22 @@ declare module "events" {
          */
         lowWaterMark?: number | undefined;
     }
+    interface StaticEventEmitterIteratorOptions extends StaticEventEmitterOptions {
+        /**
+         * Names of events that will end the iteration.
+         */
+        close?: string[];
+        /**
+         * The emitter is paused every time the size of events being buffered is higher than it. Supported only on emitters implementing pause() and resume() methods.
+         * @default Number.MAX_SAFE_INTEGER
+         */
+        highWaterMark?: number;
+        /**
+         * The emitter is resumed every time the size of events being buffered is lower than it. Supported only on emitters implementing pause() and resume() methods.
+         * @default 1
+         */
+        lowWaterMark?: number;
+    }
     interface EventEmitter<T extends EventMap<T> = DefaultEventMap> extends NodeJS.EventEmitter<T> {}
     type EventMap<T> = Record<keyof T, any[]> | DefaultEventMap;
     type DefaultEventMap = [never];
@@ -274,6 +290,28 @@ declare module "events" {
          *
          * process.nextTick(() => ac.abort());
          * ```
+         *
+         * Use the `close` option to specify an array of event names that will end the iteration:
+         *
+         * ```js
+         * import { on, EventEmitter } from 'node:events';
+         * import process from 'node:process';
+         *
+         * const ee = new EventEmitter();
+         *
+         * // Emit later on
+         * process.nextTick(() => {
+         *   ee.emit('foo', 'bar');
+         *   ee.emit('foo', 42);
+         *   ee.emit('close');
+         * });
+         *
+         * for await (const event of on(ee, 'foo', { close: ['close'] })) {
+         *   console.log(event); // prints ['bar'] [42]
+         * }
+         * // the loop will exit after 'close' is emitted
+         * console.log('done'); // prints 'done'
+         * ```
          * @since v13.6.0, v12.16.0
          * @param eventName The name of the event being listened for
          * @return An `AsyncIterator` that iterates `eventName` events emitted by the `emitter`
@@ -286,7 +324,7 @@ declare module "events" {
         static on(
             emitter: EventTarget,
             eventName: string,
-            options?: StaticEventEmitterOptions,
+            options?: StaticEventEmitterIteratorOptions,
         ): AsyncIterableIterator<any>;
         /**
          * A class method that returns the number of listeners for the given `eventName` registered on the given `emitter`.

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "20.14.4",
+    "version": "20.14.5",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -212,6 +212,6 @@
     "dependencies": {
         "undici-types": "~5.26.4"
     },
-    "typesPublisherContentHash": "51d4ba5b24961c3ba56036b7cd2fe8a17897079f173eb00cc8cf362445289de9",
+    "typesPublisherContentHash": "8dc6f8d71b81b71918d54a2fc8b71f492e0c9ebb263ffe4a93970039c9aadd3b",
     "typeScriptVersion": "4.7"
 }