Skip to content

Commit

Permalink
doc: add annotation to writeFile data as Object
Browse files Browse the repository at this point in the history
Fixes: #39152
  • Loading branch information
JakobJingleheimer committed Jun 29, 2021
1 parent 44ecd41 commit 941010d
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,9 @@ changes:
Write `buffer` to the file.
If `buffer` is a plain object, like all variations of `writeFile`, 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
Expand Down Expand Up @@ -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, like all variations of `writeFile`, an
object with an own (not inherited) `toString` function property.
The `encoding` option is ignored if `data` is a buffer.
Expand Down Expand Up @@ -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, like all variations of `writeFile`, it must have an
own (not inherited) `toString` function property.
```mjs
import { writeFile } from 'fs';
Expand Down Expand Up @@ -5034,6 +5039,9 @@ changes:
Returns `undefined`.
If `data` is a plain object, like all variations of `writeFile`, 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()`][].
Expand Down Expand Up @@ -5068,6 +5076,9 @@ changes:
* `position` {integer}
* Returns: {number} The number of bytes written.
If `buffer` is a plain object, like all variations of `writeFile`, 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...)`][].
Expand All @@ -5094,6 +5105,9 @@ changes:
* `encoding` {string}
* Returns: {number} The number of bytes written.
If `string` is a plain object, like all variations of `writeFile`, 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...)`][].
Expand Down

0 comments on commit 941010d

Please sign in to comment.