Skip to content

Fs writefile docs update #31104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
juanarbol wants to merge 3 commits into from
Closed

Fs writefile docs update #31104

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dfe5d0
doc: remove extra space on fs docs
juanarbol Dec 26, 2019
55524c2
doc: fs.write is not longer coercing strings
juanarbol Dec 26, 2019
2e29ecb
fixup
juanarbol Dec 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3982,7 +3982,7 @@ changes:
* `string` {string}

Write `string` to the file specified by `fd`. If `string` is not a string, then
the value will be coerced to one.
a exception will be thrown.
Copy link
Copy Markdown
Member Author

@juanarbol juanarbol Dec 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be the new behavior, when #31030 get landed.

Copy link
Copy Markdown
Contributor

@mscdex mscdex Dec 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be incorporated into the existing PR instead?

Copy link
Copy Markdown
Member Author

@juanarbol juanarbol Dec 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @BridgeAR

Copy link
Copy Markdown
Member

@BridgeAR BridgeAR Jan 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the ping, I'll cherry-pick this in #31030.

@juanarbol please feel free to leave comments in PRs in case you see that something is missing :)

Comment thread
juanarbol marked this conversation as resolved.
Outdated

`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 at
Expand Down Expand Up @@ -4044,7 +4044,7 @@ changes:
* `err` {Error}

When `file` is a filename, asynchronously writes data to the file, replacing the
file if it already exists. `data` can be a string or a buffer.
file if it already exists. `data` can be a string or a buffer.

When `file` is a file descriptor, the behavior is similar to calling
`fs.write()` directly (which is recommended). See the notes below on using
Expand Down