1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: include the optional options parameter

Browse Source 
`mkdtemp` functions accept an optional `options` parameter, which can
be either a String specifying encoding, or an Object with an `encoding`
property.

PR-URL: https://github.com/nodejs/node/pull/7842
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
This commit is contained in:
Sakthipriyan Vairamani 2016-07-23 00:03:24 +05:30 committed by James M Snell
parent 51f96dfcfc
commit 6e50fc7637
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/api/fs.md
View File

@ -893,11 +893,16 @@ added: v0.1.21
Synchronous mkdir(2). Returns `undefined`. Synchronous mkdir(2). Returns `undefined`.
## fs.mkdtemp(prefix, callback) ## fs.mkdtemp(prefix[, options], callback)
<!-- YAML <!-- YAML
added: v5.10.0 added: v5.10.0
--> -->
* `prefix` {String}
* `options` {String | Object}
* `encoding` {String} default = `'utf8'`
* `callback` {Function}
Creates a unique temporary directory. Creates a unique temporary directory.
Generates six random characters to be appended behind a required Generates six random characters to be appended behind a required
@ -906,10 +911,14 @@ Generates six random characters to be appended behind a required
The created folder path is passed as a string to the callback's second The created folder path is passed as a string to the callback's second
parameter. parameter.
The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.
Example: Example:
```js ```js
fs.mkdtemp('/tmp/foo-', (err, folder) => { fs.mkdtemp('/tmp/foo-', (err, folder) => {
if (err) throw err;
console.log(folder); console.log(folder);
// Prints: /tmp/foo-itXde2 // Prints: /tmp/foo-itXde2
}); });
@ -946,14 +955,21 @@ fs.mkdtemp(tmpDir + path.sep, (err, folder) => {
}); });
``` ```
## fs.mkdtempSync(prefix) ## fs.mkdtempSync(prefix[, options])
<!-- YAML <!-- YAML
added: v5.10.0 added: v5.10.0
--> -->
* `prefix` {String}
* `options` {String | Object}
* `encoding` {String} default = `'utf8'`
The synchronous version of [`fs.mkdtemp()`][]. Returns the created The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path. folder path.
The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.
## fs.open(path, flags[, mode], callback) ## fs.open(path, flags[, mode], callback)
<!-- YAML <!-- YAML
added: v0.0.2 added: v0.0.2