Skip to content

Commit 2ef8359

Browse files
thefourtheyejasnell
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 e11221c commit 2ef8359

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
@@ -931,7 +931,7 @@ fs.mkdtemp(tmpDir + path.sep, (err, folder) => {
931931
});
932932
```
933933

934-
## fs.mkdtempSync(template)
934+
## fs.mkdtempSync(prefix)
935935
<!-- YAML
936936
added: v5.10.0
937937
-->
@@ -1930,6 +1930,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
19301930
[`fs.FSWatcher`]: #fs_class_fs_fswatcher
19311931
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
19321932
[`fs.lstat()`]: #fs_fs_lstat_path_callback
1933+
[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_callback
19331934
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
19341935
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
19351936
[`fs.readFile`]: #fs_fs_readfile_file_options_callback

0 commit comments

Comments
 (0)