@@ -351,13 +351,11 @@ added: REPLACEME
351
351
Synchronously close the directory's underlying resource handle.
352
352
Subsequent reads will result in errors.
353
353
354
- ### dir.read([ options ] )
354
+ ### dir.read()
355
355
<!-- YAML
356
356
added: REPLACEME
357
357
-->
358
358
359
- * ` options ` {Object}
360
- * ` encoding ` {string|null} ** Default:** ` 'utf8' `
361
359
* Returns: {Promise} containing {fs.Dirent}
362
360
363
361
Asynchronously read the next directory entry via readdir(3) as an
@@ -369,13 +367,11 @@ is completed.
369
367
_ Directory entries returned by this function are in no particular order as
370
368
provided by the operating system's underlying directory mechanisms._
371
369
372
- ### dir.read([ options, ] callback)
370
+ ### dir.read(callback)
373
371
<!-- YAML
374
372
added: REPLACEME
375
373
-->
376
374
377
- * ` options ` {Object}
378
- * ` encoding ` {string|null} ** Default:** ` 'utf8' `
379
375
* ` callback ` {Function}
380
376
* ` err ` {Error}
381
377
* ` dirent ` {fs.Dirent}
@@ -385,25 +381,19 @@ Asynchronously read the next directory entry via readdir(3) as an
385
381
386
382
The ` callback ` will be called with a [ Dirent] [ ] after the read is completed.
387
383
388
- The ` encoding ` option sets the encoding of the ` name ` in the ` dirent ` .
389
-
390
384
_ Directory entries returned by this function are in no particular order as
391
385
provided by the operating system's underlying directory mechanisms._
392
386
393
- ### dir.readSync([ options ] )
387
+ ### dir.readSync()
394
388
<!-- YAML
395
389
added: REPLACEME
396
390
-->
397
391
398
- * ` options ` {Object}
399
- * ` encoding ` {string|null} ** Default:** ` 'utf8' `
400
392
* Returns: {fs.Dirent}
401
393
402
394
Synchronously read the next directory entry via readdir(3) as an
403
395
[ ` fs.Dirent ` ] [ ] .
404
396
405
- The ` encoding ` option sets the encoding of the ` name ` in the ` dirent ` .
406
-
407
397
_ Directory entries returned by this function are in no particular order as
408
398
provided by the operating system's underlying directory mechanisms._
409
399
@@ -2658,8 +2648,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from
2658
2648
and cleaning up the directory.
2659
2649
2660
2650
The ` encoding ` option sets the encoding for the ` path ` while opening the
2661
- directory and subsequent read operations (unless otherwise overriden during
2662
- reads from the directory).
2651
+ directory and subsequent read operations.
2663
2652
2664
2653
## fs.opendirSync(path[ , options] )
2665
2654
<!-- YAML
@@ -2677,8 +2666,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from
2677
2666
and cleaning up the directory.
2678
2667
2679
2668
The ` encoding ` option sets the encoding for the ` path ` while opening the
2680
- directory and subsequent read operations (unless otherwise overriden during
2681
- reads from the directory).
2669
+ directory and subsequent read operations.
2682
2670
2683
2671
## fs.read(fd, buffer, offset, length, position, callback)
2684
2672
<!-- YAML
@@ -4835,8 +4823,7 @@ Creates an [`fs.Dir`][], which contains all further functions for reading from
4835
4823
and cleaning up the directory.
4836
4824
4837
4825
The ` encoding ` option sets the encoding for the ` path ` while opening the
4838
- directory and subsequent read operations (unless otherwise overriden during
4839
- reads from the directory).
4826
+ directory and subsequent read operations.
4840
4827
4841
4828
Example using async interation:
4842
4829
0 commit comments