From 3272eec22ca21497426de2be20cf623307084298 Mon Sep 17 00:00:00 2001 From: Jessica Quynh Tran Date: Thu, 24 Nov 2016 18:35:15 -0500 Subject: [PATCH] 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 --- doc/api/fs.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 8d934e98340d41..5a604ac765ed08 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1347,7 +1347,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