From a100709fa8c810911a5ff31e7382c339191d471a Mon Sep 17 00:00:00 2001
From: Lucas Holmquist <lholmqui@redhat.com>
Date: Tue, 24 Mar 2020 11:23:33 -0400
Subject: [PATCH] fs: make parameters optional for readSync

This makes the offset, length and position parameters optional by
passing in an options object.

PR-URL: https://github.com/nodejs/node/pull/32460
Reviewed-By: Anna Henningsen <anna@addaleax.net>
---
 doc/api/fs.md                                 | 26 ++++++++++++++++++
 lib/fs.js                                     | 12 +++++++++
 .../test-fs-readSync-optional-params.js       | 27 +++++++++++++++++++
 3 files changed, 65 insertions(+)
 create mode 100644 test/parallel/test-fs-readSync-optional-params.js

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 9cca6599b16525..bbbf40c47a173e 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -3080,6 +3080,32 @@ Returns the number of `bytesRead`.
 For detailed information, see the documentation of the asynchronous version of
 this API: [`fs.read()`][].
 
+## `fs.readSync(fd, buffer, [options])`
+<!-- YAML
+added: REPLACEME
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/32460
+    description: Options object can be passed in
+                 to make offset, length and position optional
+-->
+
+* `fd` {integer}
+* `buffer` {Buffer|TypedArray|DataView}
+* `options` {Object}
+  * `offset` {integer} **Default:** `0`
+  * `length` {integer} **Default:** `buffer.length`
+  * `position` {integer} **Default:** `null`
+* Returns: {number}
+
+Returns the number of `bytesRead`.
+
+Similar to the above `fs.readSync` function, this version takes an optional `options` object.
+If no `options` object is specified, it will default with the above values.
+
+For detailed information, see the documentation of the asynchronous version of
+this API: [`fs.read()`][].
+
 ## `fs.readv(fd, buffers[, position], callback)`
 <!-- YAML
 added: REPLACEME
diff --git a/lib/fs.js b/lib/fs.js
index 3e253ef8c68979..4a19e3b6033711 100644
--- a/lib/fs.js
+++ b/lib/fs.js
@@ -525,8 +525,20 @@ function read(fd, buffer, offset, length, position, callback) {
 ObjectDefineProperty(read, internalUtil.customPromisifyArgs,
                      { value: ['bytesRead', 'buffer'], enumerable: false });
 
+// usage:
+// fs.readSync(fd, buffer, offset, length, position);
+// OR
+// fs.readSync(fd, buffer, {}) or fs.readSync(fd, buffer)
 function readSync(fd, buffer, offset, length, position) {
   validateInt32(fd, 'fd', 0);
+
+  if (arguments.length <= 3) {
+    // Assume fs.read(fd, buffer, options)
+    const options = offset || {};
+
+    ({ offset = 0, length = buffer.length, position } = options);
+  }
+
   validateBuffer(buffer);
 
   offset |= 0;
diff --git a/test/parallel/test-fs-readSync-optional-params.js b/test/parallel/test-fs-readSync-optional-params.js
new file mode 100644
index 00000000000000..37d3d24911db51
--- /dev/null
+++ b/test/parallel/test-fs-readSync-optional-params.js
@@ -0,0 +1,27 @@
+'use strict';
+
+require('../common');
+const fixtures = require('../common/fixtures');
+const fs = require('fs');
+const assert = require('assert');
+const filepath = fixtures.path('x.txt');
+const fd = fs.openSync(filepath, 'r');
+
+const expected = Buffer.from('xyz\n');
+
+function runTest(defaultBuffer, options) {
+  const result = fs.readSync(fd, defaultBuffer, options);
+  assert.strictEqual(result, expected.length);
+  assert.deepStrictEqual(defaultBuffer, expected);
+}
+
+// Test passing in an empty options object
+runTest(Buffer.allocUnsafe(expected.length), { position: 0 });
+
+// Test not passing in any options object
+runTest(Buffer.allocUnsafe(expected.length));
+
+// Test passing in options
+runTest(Buffer.allocUnsafe(expected.length), { offset: 0,
+                                               length: expected.length,
+                                               position: 0 });