Skip to content

Commit 7f68e77

Browse files
committed
squash: update docs
1 parent c2bb51b commit 7f68e77

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/api/fs.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3069,6 +3069,32 @@ Returns the number of `bytesRead`.
30693069
For detailed information, see the documentation of the asynchronous version of
30703070
this API: [`fs.read()`][].
30713071

3072+
## `fs.readSync(fd, buffer, [options])`
3073+
<!-- YAML
3074+
added: REPLACEME
3075+
changes:
3076+
- version: REPLACEME
3077+
pr-url: https://github.com/nodejs/node/pull/32460
3078+
description: Options object can be passed in
3079+
to make offset, length and position optional
3080+
-->
3081+
3082+
* `fd` {integer}
3083+
* `buffer` {Buffer|TypedArray|DataView}
3084+
* `options` {Object}
3085+
* `offset` {integer} **Default:** `0`
3086+
* `length` {integer} **Default:** `buffer.length`
3087+
* `position` {integer} **Default:** `null`
3088+
* Returns: {number}
3089+
3090+
Returns the number of `bytesRead`.
3091+
3092+
Similar to the above `fs.readSync` function, this version takes an optional `options` object.
3093+
If no `options` object is specified, it will default with the above values.
3094+
3095+
For detailed information, see the documentation of the asynchronous version of
3096+
this API: [`fs.read()`][].
3097+
30723098
## `fs.readv(fd, buffers[, position], callback)`
30733099
<!-- YAML
30743100
added: REPLACEME

0 commit comments

Comments
 (0)