Skip to content

Commit 68c0518

Browse files
vsemozhetbytaddaleax
authored andcommitted
doc: fix links and typos in fs.md
PR-URL: #13573 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent e713482 commit 68c0518

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/api/fs.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1706,7 +1706,7 @@ changes:
17061706
parameter in case of success.
17071707
- version: v5.0.0
17081708
pr-url: https://github.com/nodejs/node/pull/3163
1709-
description: The `file` parameter can be a file descriptor now.
1709+
description: The `path` parameter can be a file descriptor now.
17101710
-->
17111711

17121712
* `path` {string|Buffer|URL|integer} filename or file descriptor
@@ -1766,15 +1766,15 @@ changes:
17661766
protocol. Support is currently still *experimental*.
17671767
- version: v5.0.0
17681768
pr-url: https://github.com/nodejs/node/pull/3163
1769-
description: The `file` parameter can be a file descriptor now.
1769+
description: The `path` parameter can be a file descriptor now.
17701770
-->
17711771

17721772
* `path` {string|Buffer|URL|integer} filename or file descriptor
17731773
* `options` {Object|string}
17741774
* `encoding` {string|null} default = `null`
17751775
* `flag` {string} default = `'r'`
17761776

1777-
Synchronous version of [`fs.readFile`][]. Returns the contents of the `file`.
1777+
Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.
17781778

17791779
If the `encoding` option is specified then this function returns a
17801780
string. Otherwise it returns a buffer.
@@ -2838,7 +2838,8 @@ The following constants are meant for use with the [`fs.Stats`][] object's
28382838
[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_options_callback
28392839
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
28402840
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
2841-
[`fs.readFile`]: #fs_fs_readfile_file_options_callback
2841+
[`fs.readFile()`]: #fs_fs_readfile_path_options_callback
2842+
[`fs.readFileSync()`]: #fs_fs_readfilesync_path_options
28422843
[`fs.stat()`]: #fs_fs_stat_path_callback
28432844
[`fs.utimes()`]: #fs_fs_utimes_path_atime_mtime_callback
28442845
[`fs.watch()`]: #fs_fs_watch_filename_options_listener

0 commit comments

Comments
 (0)