Skip to content
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

doc: fs.readFile() can accept a string for the second argument, resolves #1797 #1806

Closed
wants to merge 2 commits into from
Closed

doc: fs.readFile() can accept a string for the second argument, resolves #1797 #1806

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c5c132
doc: `fs.readFile()` can accept a string for the second argument
Trott May 27, 2015
d34de07
doc: fs.*File functions treat string values for `object` as encoding
Trott May 27, 2015
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
18 changes: 15 additions & 3 deletions doc/api/fs.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Synchronous version of `fs.read`. Returns the number of `bytesRead`.
## fs.readFile(filename[, options], callback)

* `filename` {String}
* `options` {Object}
* `options` {Object | String}
* `encoding` {String | Null} default = `null`
* `flag` {String} default = `'r'`
* `callback` {Function}
Expand All @@ -472,6 +472,10 @@ contents of the file.

If no encoding is specified, then the raw buffer is returned.

If `options` is a string, then it specifies the encoding. Example:

fs.readFile('/etc/passwd', 'utf8', callback);


## fs.readFileSync(filename[, options])

Expand All @@ -485,7 +489,7 @@ string. Otherwise it returns a buffer.

* `filename` {String}
* `data` {String | Buffer}
* `options` {Object}
* `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `0o666`
* `flag` {String} default = `'w'`
Expand All @@ -504,6 +508,10 @@ Example:
console.log('It\'s saved!');
});

If `options` is a string, then it specifies the encoding. Example:

fs.writeFile('message.txt', 'Hello io.js', 'utf8', callback);

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

The synchronous version of `fs.writeFile`.
Expand All @@ -512,7 +520,7 @@ The synchronous version of `fs.writeFile`.

* `filename` {String}
* `data` {String | Buffer}
* `options` {Object}
* `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `0o666`
* `flag` {String} default = `'a'`
Expand All @@ -528,6 +536,10 @@ Example:
console.log('The "data to append" was appended to file!');
});

If `options` is a string, then it specifies the encoding. Example:

fs.appendFile('message.txt', 'data to append', 'utf8', callback);

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

The synchronous version of `fs.appendFile`.
Expand Down