stream: deprecate asIndexedPairs

nodejs · May 23, 2023 · f5e17ea · f5e17ea
1 parent 1229a22
commit f5e17ea
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -3378,6 +3378,20 @@ In a future version of Node.js, [`assert.CallTracker`][],
 will be removed.
 Consider using alternatives such as the [`mock`][] helper function.
 
+### DEP0174: the `readable.asIndexedPairs` method
+
+<!-- YAML
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/48102
+    description: Runtime deprecation.
+-->
+
+Type: Runtime
+
+In a future version of Node.js, [`readable.asIndexedPairs`][],
+will be removed.
+
 [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
 [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
 [RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
@@ -3469,6 +3483,7 @@ Consider using alternatives such as the [`mock`][] helper function.
 [`process.getActiveResourcesInfo()`]: process.md#processgetactiveresourcesinfo
 [`process.mainModule`]: process.md#processmainmodule
 [`punycode`]: punycode.md
+[`readable.asIndexedPairs`]: stream.md#readableasindexedpairsoptions
 [`readable.readableEnded`]: stream.md#readablereadableended
 [`request.abort()`]: http.md#requestabort
 [`request.connection`]: http.md#requestconnection

diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2453,9 +2453,14 @@ await Readable.from([1, 2, 3, 4]).take(2).toArray(); // [1, 2]
 added:
   - v17.5.0
   - v16.15.0
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/48102
+    description: the `asIndexedPairs` property has been deprecated and will be
+                  removed in a future version.
 -->
 
-> Stability: 1 - Experimental
+> Stability: 0 - Deprecated
 
 * `options` {Object}
   * `signal` {AbortSignal} allows destroying the stream if the signal is

diff --git a/lib/internal/streams/operators.js b/lib/internal/streams/operators.js
@@ -23,6 +23,7 @@ const {
   addAbortSignalNoValidate,
 } = require('internal/streams/add-abort-signal');
 const { isWritable, isNodeStream } = require('internal/streams/utils');
+const { deprecate } = require('internal/util');
 
 const {
   ArrayPrototypePush,
@@ -420,7 +421,7 @@ function take(number, options = undefined) {
 }
 
 module.exports.streamReturningOperators = {
-  asIndexedPairs,
+  asIndexedPairs: deprecate(asIndexedPairs, 'readable.asIndexedPairs is deprecated.', 'DEP0174'),
   drop,
   filter,
   flatMap,

diff --git a/test/parallel/test-stream-iterator-helpers-test262-tests.mjs b/test/parallel/test-stream-iterator-helpers-test262-tests.mjs
@@ -60,8 +60,6 @@ import assert from 'assert';
   }
   // asIndexedPairs/length.js
   assert.strictEqual(Readable.prototype.asIndexedPairs.length, 0);
-  // asIndexedPairs/name.js
-  assert.strictEqual(Readable.prototype.asIndexedPairs.name, 'asIndexedPairs');
   const descriptor = Object.getOwnPropertyDescriptor(
     Readable.prototype,
     'asIndexedPairs'