Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLivia Medeiros <74449973+LiviaMedeiros@users.noreply.github.com>2022-05-02 21:01:27 +0300
committerGitHub <noreply@github.com>2022-05-02 21:01:27 +0300
commit57678e55817366c39a3a241f89949c8fbe8418bc (patch)
tree12f8024cd2716feaeb6ed7cfdf0681c2a372ac1d /doc
parent6be94c9443c890cd5706cfa6508c4c00e06dfe9e (diff)
fs: add `read(buffer[, options])` versions
This adds the following: - `fs.read(fd, buffer[, options], callback)`. - `filehandle.read(buffer[, options])`. PR-URL: https://github.com/nodejs/node/pull/42768 Refs: https://github.com/nodejs/node/pull/42601 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index a6f0a22cbf9..fc27ea30d1f 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -417,6 +417,33 @@ Reads data from the file and stores that in the given buffer.
If the file is not modified concurrently, the end-of-file is reached when the
number of bytes read is zero.
+#### `filehandle.read(buffer[, options])`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `buffer` {Buffer|TypedArray|DataView} A buffer that will be filled with the
+ file data read.
+* `options` {Object}
+ * `offset` {integer} The location in the buffer at which to start filling.
+ **Default:** `0`
+ * `length` {integer} The number of bytes to read. **Default:**
+ `buffer.byteLength - offset`
+ * `position` {integer} The location where to begin reading data from the
+ file. If `null`, data will be read from the current file position, and
+ the position will be updated. If `position` is an integer, the current
+ file position will remain unchanged. **Default:**: `null`
+* Returns: {Promise} Fulfills upon success with an object with two properties:
+ * `bytesRead` {integer} The number of bytes read
+ * `buffer` {Buffer|TypedArray|DataView} A reference to the passed in `buffer`
+ argument.
+
+Reads data from the file and stores that in the given buffer.
+
+If the file is not modified concurrently, the end-of-file is reached when the
+number of bytes read is zero.
+
#### `filehandle.readableWebStream()`
<!-- YAML
@@ -3247,6 +3274,28 @@ Similar to the [`fs.read()`][] function, this version takes an optional
`options` object. If no `options` object is specified, it will default with the
above values.
+### `fs.read(fd, buffer[, options], callback)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `fd` {integer}
+* `buffer` {Buffer|TypedArray|DataView} The buffer that the data will be
+ written to.
+* `options` {Object}
+ * `offset` {integer} **Default:** `0`
+ * `length` {integer} **Default:** `buffer.byteLength - offset`
+ * `position` {integer|bigint} **Default:** `null`
+* `callback` {Function}
+ * `err` {Error}
+ * `bytesRead` {integer}
+ * `buffer` {Buffer}
+
+Similar to the [`fs.read()`][] function, this version takes an optional
+`options` object. If no `options` object is specified, it will default with the
+above values.
+
### `fs.readdir(path[, options], callback)`
<!-- YAML