fs: support util.promisify for fs.readv

PR-URL: #33590 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
nodejs · Jul 8, 2020 · c9cf41d · c9cf41d
1 parent 8dbf334
commit c9cf41d
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -3130,6 +3130,9 @@ from the current position.
 The callback will be given three arguments: `err`, `bytesRead`, and
 `buffers`. `bytesRead` is how many bytes were read from the file.
 
+If this method is invoked as its [`util.promisify()`][]ed version, it returns
+a `Promise` for an `Object` with `bytesRead` and `buffers` properties.
+
 ## `fs.readvSync(fd, buffers[, position])`
 <!-- YAML
 added: v12.17.0

diff --git a/lib/fs.js b/lib/fs.js
@@ -584,6 +584,9 @@ function readv(fd, buffers, position, callback) {
   return binding.readBuffers(fd, buffers, position, req);
 }
 
+ObjectDefineProperty(readv, internalUtil.customPromisifyArgs,
+                     { value: ['bytesRead', 'buffers'], enumerable: false });
+
 function readvSync(fd, buffers, position) {
   validateInt32(fd, 'fd', 0);
   validateBufferArray(buffers);

diff --git a/test/parallel/test-fs-readv-promisify.js b/test/parallel/test-fs-readv-promisify.js
@@ -0,0 +1,18 @@
+'use strict';
+
+const common = require('../common');
+const fixtures = require('../common/fixtures');
+const fs = require('fs');
+const readv = require('util').promisify(fs.readv);
+const assert = require('assert');
+const filepath = fixtures.path('x.txt');
+const fd = fs.openSync(filepath, 'r');
+
+const expected = [Buffer.from('xyz\n')];
+
+readv(fd, expected)
+  .then(function({ bytesRead, buffers }) {
+    assert.deepStrictEqual(bytesRead, expected[0].length);
+    assert.deepStrictEqual(buffers, expected);
+  })
+  .then(common.mustCall());