Browse Source

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: https://github.com/nodejs/node/pull/9792
Ref: https://github.com/nodejs/node/issues/7868
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
v7.x
Jessica Quynh Tran 8 years ago
committed by Italo A. Casas
parent
commit
520b1f7853
  1. 3
      doc/api/fs.md

3
doc/api/fs.md

@ -1832,7 +1832,8 @@ added: v0.0.2
Write `buffer` to the file specified by `fd`.
`offset` and `length` determine the part of the buffer to be written.
`offset` determines the part of the buffer to be written, and `length` is
an integer specifying the number of bytes to write.
`position` refers to the offset from the beginning of the file where this data
should be written. If `typeof position !== 'number'`, the data will be written

Loading…
Cancel
Save