Browse Source

doc: `fs.*File()` also accept encoding strings

Fixes: https://github.com/nodejs/io.js/issues/1797
PR-URL: https://github.com/nodejs/io.js/pull/1806
Reviewed-By: fishrock123@rocketmail.com
v2.3.1-release
Rich Trott 10 years ago
committed by Jeremiah Senkpiel
parent
commit
ff794498e7
  1. 18
      doc/api/fs.markdown

18
doc/api/fs.markdown

@ -455,7 +455,7 @@ Synchronous version of `fs.read`. Returns the number of `bytesRead`.
## fs.readFile(filename[, options], callback) ## fs.readFile(filename[, options], callback)
* `filename` {String} * `filename` {String}
* `options` {Object} * `options` {Object | String}
* `encoding` {String | Null} default = `null` * `encoding` {String | Null} default = `null`
* `flag` {String} default = `'r'` * `flag` {String} default = `'r'`
* `callback` {Function} * `callback` {Function}
@ -472,6 +472,10 @@ contents of the file.
If no encoding is specified, then the raw buffer is returned. 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]) ## fs.readFileSync(filename[, options])
@ -485,7 +489,7 @@ string. Otherwise it returns a buffer.
* `filename` {String} * `filename` {String}
* `data` {String | Buffer} * `data` {String | Buffer}
* `options` {Object} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `0o666` * `mode` {Number} default = `0o666`
* `flag` {String} default = `'w'` * `flag` {String} default = `'w'`
@ -504,6 +508,10 @@ Example:
console.log('It\'s saved!'); 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]) ## fs.writeFileSync(filename, data[, options])
The synchronous version of `fs.writeFile`. The synchronous version of `fs.writeFile`.
@ -512,7 +520,7 @@ The synchronous version of `fs.writeFile`.
* `filename` {String} * `filename` {String}
* `data` {String | Buffer} * `data` {String | Buffer}
* `options` {Object} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {String | Null} default = `'utf8'`
* `mode` {Number} default = `0o666` * `mode` {Number} default = `0o666`
* `flag` {String} default = `'a'` * `flag` {String} default = `'a'`
@ -528,6 +536,10 @@ Example:
console.log('The "data to append" was appended to file!'); 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]) ## fs.appendFileSync(filename, data[, options])
The synchronous version of `fs.appendFile`. The synchronous version of `fs.appendFile`.

Loading…
Cancel
Save