Commit 787d4ec
doc: clarifying variables in fs.write()
This commit clarifies variables in the Filesystem docs.
Prior, the documentation for fs.write() had an ambiguous
remark on the parameters of offset and length.
Therefore, this commit makes explicit that the length parameter
in fs.write() is used to denote the number of bytes, which is
a clearer reference for its usage.
PR-URL: #9792
Ref: #7868
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>1 parent f48c86c commit 787d4ec
1 file changed
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1832,7 +1832,8 @@ added: v0.0.2 | |||
| 1832 | 1832 | ||
| 1833 | 1833 | Write `buffer` to the file specified by `fd`. | |
| 1834 | 1834 | ||
| 1835 | - `offset` and `length` determine the part of the buffer to be written. | ||
| 1835 | + `offset` determines the part of the buffer to be written, and `length` is | ||
| 1836 | + an integer specifying the number of bytes to write. | ||
| 1836 | 1837 | ||
| 1837 | 1838 | `position` refers to the offset from the beginning of the file where this data | |
| 1838 | 1839 | should be written. If `typeof position !== 'number'`, the data will be written | |
0 commit comments