fs: fix read / readSync positional offset types

ruyadorno · marco-ippolito · commit ca5b82714845 · 2024-05-03T08:30:34.000+02:00
This changeset fixes the types in comments to match the implementation. PR-URL: #52603 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: LiviaMedeiros <livia@cirno.name> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/lib/fs.js b/lib/fs.js
@@ -599,7 +599,11 @@ function openAsBlob(path, options = kEmptyObject) {
  * Reads file from the specified `fd` (file descriptor).
  * @param {number} fd
  * @param {Buffer | TypedArray | DataView} buffer
- * @param {number} offsetOrOptions
+ * @param {number | {
+ *   offset?: number;
+ *   length?: number;
+ *   position?: number | bigint | null;
+ *   }} [offsetOrOptions]
  * @param {number} length
  * @param {number | bigint | null} position
  * @param {(
@@ -692,7 +696,7 @@ ObjectDefineProperty(read, kCustomPromisifyArgsSymbol,
  * specified `fd` (file descriptor).
  * @param {number} fd
  * @param {Buffer | TypedArray | DataView} buffer
- * @param {{
+ * @param {number | {
  *   offset?: number;
  *   length?: number;
  *   position?: number | bigint | null;
