Skip to content

doc: updated fs #5877

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
ToPal wants to merge 2 commits into from
Closed

doc: updated fs #5877

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ee2c02
doc: updated fs
ToPal Mar 23, 2016
53dfad2
doc: updated fs
ToPal Mar 24, 2016
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
Prev Previous commit
doc: updated fs 
#5862
removed irrelevant data about fs.writeFile and fs.appendFile
  • Loading branch information
@ToPal
ToPal committed Mar 24, 2016
commit 53dfad285c09e83393ffc2b76f49d04b298f194e
12 changes: 2 additions & 10 deletions doc/api/fs.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ fail, and does nothing otherwise.

## fs.appendFile(file, data[, options], callback)

* `file` {String|Number} filename or file descriptor
* `file` {String} filename
* `data` {String|Buffer}
* `options` {Object|String}
* `encoding` {String|Null} default = `'utf8'`
Expand All @@ -278,10 +278,6 @@ If `options` is a string, then it specifies the encoding. Example:
fs.appendFile('message.txt', 'data to append', 'utf8', callback);
```

Any specified file descriptor has to have been opened for appending.

_Note: Specified file descriptors will not be closed automatically._

## fs.appendFileSync(file, data[, options])

The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.
Expand Down Expand Up @@ -941,7 +937,7 @@ the end of the file.

## fs.writeFile(file, data[, options], callback)

* `file` {String | Integer} filename or file descriptor
* `file` {String} filename
* `data` {String | Buffer}
* `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'`
Expand Down Expand Up @@ -970,14 +966,10 @@ If `options` is a string, then it specifies the encoding. Example:
fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);
```

Any specified file descriptor has to support writing.

Note that it is unsafe to use `fs.writeFile` multiple times on the same file
without waiting for the callback. For this scenario,
`fs.createWriteStream` is strongly recommended.

_Note: Specified file descriptors will not be closed automatically._

## fs.writeFileSync(file, data[, options])

The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
Expand Down