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

doc: fix descriptions of sync methods in fs.md

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/21747
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
Tim Ruffles 2018-07-11 10:10:42 +01:00 committed by Vse Mozhet Byt
parent 2058a1c35a
commit 2d48f97ddd
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/fs.md
View File

@ -2336,7 +2336,7 @@ Synchronous readdir(3).
The optional `options` argument can be a string specifying an encoding, or an The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use for object with an `encoding` property specifying the character encoding to use for
the filenames passed to the callback. If the `encoding` is set to `'buffer'`, the filenames returned. If the `encoding` is set to `'buffer'`,
the filenames returned will be passed as `Buffer` objects. the filenames returned will be passed as `Buffer` objects.
## fs.readFile(path[, options], callback) ## fs.readFile(path[, options], callback)
@ -2508,7 +2508,7 @@ Synchronous readlink(2). Returns the symbolic link's string value.
The optional `options` argument can be a string specifying an encoding, or an The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use for object with an `encoding` property specifying the character encoding to use for
the link path passed to the callback. If the `encoding` is set to `'buffer'`, the link path returned. If the `encoding` is set to `'buffer'`,
the link path returned will be passed as a `Buffer` object. the link path returned will be passed as a `Buffer` object.
## fs.readSync(fd, buffer, offset, length, position) ## fs.readSync(fd, buffer, offset, length, position)
@ -2666,7 +2666,7 @@ Only paths that can be converted to UTF8 strings are supported.
The optional `options` argument can be a string specifying an encoding, or an The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use for object with an `encoding` property specifying the character encoding to use for
the path passed to the callback. If the `encoding` is set to `'buffer'`, the path returned. If the `encoding` is set to `'buffer'`,
the path returned will be passed as a `Buffer` object. the path returned will be passed as a `Buffer` object.
On Linux, when Node.js is linked against musl libc, the procfs file system must On Linux, when Node.js is linked against musl libc, the procfs file system must