summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSakthipriyan Vairamani <thechargingvolcano@gmail.com>2016-05-18 15:12:24 +0530
committerJames M Snell <jasnell@gmail.com>2016-05-20 07:39:21 -0700
commit2ef83590ce59e5525a7aa784439fd28428b23d9a (patch)
treed838d796758eeb38ded716a00b3f42caab7da888 /doc
parente11221c76d1ca303cd5e477fd7d7323226103413 (diff)
downloadandroid-node-v8-2ef83590ce59e5525a7aa784439fd28428b23d9a.tar.gz
android-node-v8-2ef83590ce59e5525a7aa784439fd28428b23d9a.tar.bz2
android-node-v8-2ef83590ce59e5525a7aa784439fd28428b23d9a.zip
doc: make param names consistent & fix doc link
The parameter to `fs.mkdtemp` is actually `prefix`, not `template`, because the string passed is appended with the randomly generated string. The doc link for `fs.mkdtemp()` was missing and it is included in this patch. PR-URL: https://github.com/nodejs/node/pull/6832 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 8e2d8c289c..d84a49cd3a 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -931,7 +931,7 @@ fs.mkdtemp(tmpDir + path.sep, (err, folder) => {
});
```
-## fs.mkdtempSync(template)
+## fs.mkdtempSync(prefix)
<!-- YAML
added: v5.10.0
-->
@@ -1930,6 +1930,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
[`fs.FSWatcher`]: #fs_class_fs_fswatcher
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
[`fs.lstat()`]: #fs_fs_lstat_path_callback
+[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_callback
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
[`fs.readFile`]: #fs_fs_readfile_file_options_callback