diff --git a/doc/api/fs.md b/doc/api/fs.md index b4f2c1e11a14b0..a220e1a18728ef 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -450,6 +450,9 @@ changes: Write `buffer` to the file. +If `buffer` is a plain object, it must have an own (not inherited) `toString` +function property. + The promise is resolved with an object containing two properties: * `bytesWritten` {integer} the number of bytes written @@ -1290,8 +1293,8 @@ changes: * Returns: {Promise} Fulfills with `undefined` upon success. Asynchronously writes data to a file, replacing the file if it already exists. -`data` can be a string, a {Buffer}, or an object with an own `toString` function -property. +`data` can be a string, a {Buffer}, or, an object with an own (not inherited) +`toString` function property. The `encoding` option is ignored if `data` is a buffer. @@ -3947,7 +3950,9 @@ When `file` is a file descriptor, the behavior is similar to calling a file descriptor. The `encoding` option is ignored if `data` is a buffer. -If `data` is a normal object, it must have an own `toString` function property. + +If `data` is a plain object, it must have an own (not inherited) `toString` +function property. ```mjs import { writeFile } from 'fs'; @@ -5034,6 +5039,9 @@ changes: Returns `undefined`. +If `data` is a plain object, it must have an own (not inherited) `toString` +function property. + For detailed information, see the documentation of the asynchronous version of this API: [`fs.writeFile()`][]. @@ -5068,6 +5076,9 @@ changes: * `position` {integer} * Returns: {number} The number of bytes written. +If `buffer` is a plain object, it must have an own (not inherited) `toString` +function property. + For detailed information, see the documentation of the asynchronous version of this API: [`fs.write(fd, buffer...)`][]. @@ -5094,6 +5105,9 @@ changes: * `encoding` {string} * Returns: {number} The number of bytes written. +If `string` is a plain object, it must have an own (not inherited) `toString` +function property. + For detailed information, see the documentation of the asynchronous version of this API: [`fs.write(fd, string...)`][].