diff options
author | Livia Medeiros <74449973+LiviaMedeiros@users.noreply.github.com> | 2022-05-02 20:40:30 +0300 |
---|---|---|
committer | RafaelGSS <rafael.nunu@hotmail.com> | 2022-05-10 15:13:15 +0300 |
commit | 924670f3af1500c8723eb287365e2539190294ea (patch) | |
tree | 15e80fb36a4b2c7f56e4264e7161871bdc9e9fdb /doc | |
parent | 72b90fd5f5f229d51fff46165a91a5aae0246bab (diff) |
doc: clarify some default values in `fs.md`
PR-URL: https://github.com/nodejs/node/pull/42892
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/fs.md | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 46a15ba5473..1422bee91fc 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -374,7 +374,7 @@ added: v10.0.0 file data read. * `offset` {integer} The location in the buffer at which to start filling. * `length` {integer} The number of bytes to read. -* `position` {integer} The location where to begin reading data from the +* `position` {integer|null} 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. @@ -403,7 +403,7 @@ added: **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 + * `position` {integer|null} 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` @@ -497,9 +497,9 @@ added: --> * `buffers` {Buffer\[]|TypedArray\[]|DataView\[]} -* `position` {integer} The offset from the beginning of the file where the data - should be read from. If `position` is not a `number`, the data will be read - from the current position. +* `position` {integer|null} The offset from the beginning of the file where + the data should be read from. If `position` is not a `number`, the data will + be read from the current position. **Default:** `null` * Returns: {Promise} Fulfills upon success an object containing two properties: * `bytesRead` {integer} the number of bytes read * `buffers` {Buffer\[]|TypedArray\[]|DataView\[]} property containing @@ -597,10 +597,10 @@ changes: to write begins. **Default:** `0` * `length` {integer} The number of bytes from `buffer` to write. **Default:** `buffer.byteLength - offset` -* `position` {integer} The offset from the beginning of the file where the +* `position` {integer|null} The offset from the beginning of the file where the data from `buffer` should be written. If `position` is not a `number`, the data will be written at the current position. See the POSIX pwrite(2) - documentation for more detail. + documentation for more detail. **Default:** `null` * Returns: {Promise} Write `buffer` to the file. @@ -631,10 +631,10 @@ changes: --> * `string` {string} -* `position` {integer} The offset from the beginning of the file where the +* `position` {integer|null} The offset from the beginning of the file where the data from `string` should be written. If `position` is not a `number` the data will be written at the current position. See the POSIX pwrite(2) - documentation for more detail. + documentation for more detail. **Default:** `null` * `encoding` {string} The expected string encoding. **Default:** `'utf8'` * Returns: {Promise} @@ -699,9 +699,9 @@ added: v12.9.0 --> * `buffers` {Buffer\[]|TypedArray\[]|DataView\[]} -* `position` {integer} The offset from the beginning of the file where the +* `position` {integer|null} The offset from the beginning of the file where the data from `buffers` should be written. If `position` is not a `number`, - the data will be written at the current position. + the data will be written at the current position. **Default:** `null` * Returns: {Promise} Write an array of {ArrayBufferView}s to the file. @@ -3194,7 +3194,7 @@ changes: written to. * `offset` {integer} The position in `buffer` to write the data to. * `length` {integer} The number of bytes to read. -* `position` {integer|bigint} Specifies where to begin reading from in the +* `position` {integer|bigint|null} Specifies where to begin reading from in the file. If `position` is `null` or `-1 `, data will be read from the current file position, and the file position will be updated. If `position` is an integer, the file position will be unchanged. @@ -3233,7 +3233,7 @@ changes: * `buffer` {Buffer|TypedArray|DataView} **Default:** `Buffer.alloc(16384)` * `offset` {integer} **Default:** `0` * `length` {integer} **Default:** `buffer.byteLength - offset` - * `position` {integer|bigint} **Default:** `null` + * `position` {integer|bigint|null} **Default:** `null` * `callback` {Function} * `err` {Error} * `bytesRead` {integer} @@ -3498,7 +3498,7 @@ changes: * `fd` {integer} * `buffers` {ArrayBufferView\[]} -* `position` {integer} +* `position` {integer|null} **Default:** `null` * `callback` {Function} * `err` {Error} * `bytesRead` {integer} @@ -3920,7 +3920,7 @@ changes: * `target` {string|Buffer|URL} * `path` {string|Buffer|URL} -* `type` {string} +* `type` {string|null} **Default:** `null` * `callback` {Function} * `err` {Error} @@ -3931,8 +3931,8 @@ See the POSIX symlink(2) documentation for more details. The `type` argument is only available on Windows and ignored on other platforms. It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is -not set, Node.js will autodetect `target` type and use `'file'` or `'dir'`. If -the `target` does not exist, `'file'` will be used. Windows junction points +not a string, Node.js will autodetect `target` type and use `'file'` or `'dir'`. +If the `target` does not exist, `'file'` will be used. Windows junction points require the destination path to be absolute. When using `'junction'`, the `target` argument will automatically be normalized to absolute path. @@ -4359,9 +4359,9 @@ changes: * `fd` {integer} * `buffer` {Buffer|TypedArray|DataView} -* `offset` {integer} -* `length` {integer} -* `position` {integer} +* `offset` {integer} **Default:** `0` +* `length` {integer} **Default:** `buffer.byteLength - offset` +* `position` {integer|null} **Default:** `null` * `callback` {Function} * `err` {Error} * `bytesWritten` {integer} @@ -4422,7 +4422,7 @@ changes: * `fd` {integer} * `string` {string|Object} -* `position` {integer} +* `position` {integer|null} **Default:** `null` * `encoding` {string} **Default:** `'utf8'` * `callback` {Function} * `err` {Error} @@ -4623,7 +4623,7 @@ changes: * `fd` {integer} * `buffers` {ArrayBufferView\[]} -* `position` {integer} +* `position` {integer|null} **Default:** `null` * `callback` {Function} * `err` {Error} * `bytesWritten` {integer} @@ -5338,7 +5338,7 @@ object with an `encoding` property specifying the character encoding to use for the link path returned. If the `encoding` is set to `'buffer'`, the link path returned will be passed as a {Buffer} object. -### `fs.readSync(fd, buffer, offset, length, position)` +### `fs.readSync(fd, buffer, offset, length[, position])` <!-- YAML added: v0.1.21 @@ -5356,7 +5356,7 @@ changes: * `buffer` {Buffer|TypedArray|DataView} * `offset` {integer} * `length` {integer} -* `position` {integer|bigint} +* `position` {integer|bigint|null} **Default:** `null` * Returns: {number} Returns the number of `bytesRead`. @@ -5384,7 +5384,7 @@ changes: * `options` {Object} * `offset` {integer} **Default:** `0` * `length` {integer} **Default:** `buffer.byteLength - offset` - * `position` {integer|bigint} **Default:** `null` + * `position` {integer|bigint|null} **Default:** `null` * Returns: {number} Returns the number of `bytesRead`. @@ -5405,7 +5405,7 @@ added: * `fd` {integer} * `buffers` {ArrayBufferView\[]} -* `position` {integer} +* `position` {integer|null} **Default:** `null` * Returns: {number} The number of bytes read. For detailed information, see the documentation of the asynchronous version of @@ -5629,7 +5629,7 @@ changes: * `target` {string|Buffer|URL} * `path` {string|Buffer|URL} -* `type` {string} +* `type` {string|null} **Default:** `null` Returns `undefined`. @@ -5761,9 +5761,9 @@ changes: * `fd` {integer} * `buffer` {Buffer|TypedArray|DataView} -* `offset` {integer} -* `length` {integer} -* `position` {integer} +* `offset` {integer} **Default:** `0` +* `length` {integer} **Default:** `buffer.byteLength - offset` +* `position` {integer|null} **Default:** `null` * Returns: {number} The number of bytes written. For detailed information, see the documentation of the asynchronous version of @@ -5785,8 +5785,8 @@ changes: * `fd` {integer} * `string` {string} -* `position` {integer} -* `encoding` {string} +* `position` {integer|null} **Default:** `null` +* `encoding` {string} **Default:** `'utf8'` * Returns: {number} The number of bytes written. For detailed information, see the documentation of the asynchronous version of @@ -5800,7 +5800,7 @@ added: v12.9.0 * `fd` {integer} * `buffers` {ArrayBufferView\[]} -* `position` {integer} +* `position` {integer|null} **Default:** `null` * Returns: {number} The number of bytes written. For detailed information, see the documentation of the asynchronous version of |