diff options
| author | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2019-10-09 12:10:06 -0700 |
|---|---|---|
| committer | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2019-10-09 15:05:40 -0700 |
| commit | 7f22aaf62b30b84270373d74d6f0f3c2e9f88a48 (patch) | |
| tree | 8c4e14d3949bd4b307b16318525c25eeadd77896 /doc | |
| parent | 0ff4a558afeb0ec051041e8f1f9c45d876ae0530 (diff) | |
| download | android-node-v8-7f22aaf62b30b84270373d74d6f0f3c2e9f88a48.tar.gz android-node-v8-7f22aaf62b30b84270373d74d6f0f3c2e9f88a48.tar.bz2 android-node-v8-7f22aaf62b30b84270373d74d6f0f3c2e9f88a48.zip | |
fs: remove options.encoding from Dir.read*()
This is unlikely to be necessary in any case, and causes much
unwarrented complexity when implementing further
optimizations.
Refs: https://github.com/nodejs/node/pull/29893#discussion_r333179482
PR-URL: https://github.com/nodejs/node/pull/29908
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/fs.md | 25 |
1 files changed, 6 insertions, 19 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index a6736d127e..885272724d 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -351,13 +351,11 @@ added: REPLACEME Synchronously close the directory's underlying resource handle. Subsequent reads will result in errors. -### dir.read([options]) +### dir.read() <!-- YAML added: REPLACEME --> -* `options` {Object} - * `encoding` {string|null} **Default:** `'utf8'` * Returns: {Promise} containing {fs.Dirent} Asynchronously read the next directory entry via readdir(3) as an @@ -369,13 +367,11 @@ is completed. _Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms._ -### dir.read([options, ]callback) +### dir.read(callback) <!-- YAML added: REPLACEME --> -* `options` {Object} - * `encoding` {string|null} **Default:** `'utf8'` * `callback` {Function} * `err` {Error} * `dirent` {fs.Dirent} @@ -385,25 +381,19 @@ Asynchronously read the next directory entry via readdir(3) as an The `callback` will be called with a [Dirent][] after the read is completed. -The `encoding` option sets the encoding of the `name` in the `dirent`. - _Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms._ -### dir.readSync([options]) +### dir.readSync() <!-- YAML added: REPLACEME --> -* `options` {Object} - * `encoding` {string|null} **Default:** `'utf8'` * Returns: {fs.Dirent} Synchronously read the next directory entry via readdir(3) as an [`fs.Dirent`][]. -The `encoding` option sets the encoding of the `name` in the `dirent`. - _Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms._ @@ -2658,8 +2648,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from and cleaning up the directory. The `encoding` option sets the encoding for the `path` while opening the -directory and subsequent read operations (unless otherwise overriden during -reads from the directory). +directory and subsequent read operations. ## fs.opendirSync(path[, options]) <!-- YAML @@ -2677,8 +2666,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from and cleaning up the directory. The `encoding` option sets the encoding for the `path` while opening the -directory and subsequent read operations (unless otherwise overriden during -reads from the directory). +directory and subsequent read operations. ## fs.read(fd, buffer, offset, length, position, callback) <!-- YAML @@ -4835,8 +4823,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from and cleaning up the directory. The `encoding` option sets the encoding for the `path` while opening the -directory and subsequent read operations (unless otherwise overriden during -reads from the directory). +directory and subsequent read operations. Example using async interation: |