Skip to content

Commit 5afb91b

Browse files
thefourtheyervagg
authored andcommitted
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: #6832 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent e1fb480 commit 5afb91b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/api/fs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ fs.mkdtemp(tmpDir + path.sep, (err, folder) => {
923923
});
924924
```
925925

926-
## fs.mkdtempSync(template)
926+
## fs.mkdtempSync(prefix)
927927
<!-- YAML
928928
added: v5.10.0
929929
-->
@@ -1702,6 +1702,7 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
17021702
[`fs.FSWatcher`]: #fs_class_fs_fswatcher
17031703
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
17041704
[`fs.lstat()`]: #fs_fs_lstat_path_callback
1705+
[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_callback
17051706
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
17061707
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
17071708
[`fs.readFile`]: #fs_fs_readfile_file_options_callback

0 commit comments

Comments
 (0)