stream: deprecate asIndexedPairs

PR-URL: #48102 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Minwoo Jung <[email protected]>
nodejs · Jul 6, 2023 · 585d628 · 585d628
1 parent e88c079
commit 585d628
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2431,6 +2431,11 @@ await Readable.from([1, 2, 3, 4]).take(2).toArray(); // [1, 2]
 
 <!-- YAML
 added: v17.5.0
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/48102
+    description: Using the `asIndexedPairs` method emits a runtime warning that
+                  it will be removed in a future version.
 -->
 
 > Stability: 1 - Experimental

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 will be removed in a future version.'),
   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'