Skip to content

Commit 9b39973

Browse files
jalafelMylesBorins
authored andcommitted
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 <[email protected]>
1 parent d117ee9 commit 9b39973

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/api/fs.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1832,7 +1832,8 @@ added: v0.0.2
18321832

18331833
Write `buffer` to the file specified by `fd`.
18341834

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.
18361837

18371838
`position` refers to the offset from the beginning of the file where this data
18381839
should be written. If `typeof position !== 'number'`, the data will be written

0 commit comments

Comments
 (0)