dots.node.fs.dir
A class representing a directory stream.
Created by {@link opendir }, {@link opendirSync }, or fsPromises.opendir().
import { opendir } from 'node:fs/promises';
try {
const dir = await opendir('./');
for await (const dirent of dir)
console.log(dirent.name);
} catch (err) {
console.error(err);
}
When using the async iterator, the fs.Dir object will be automatically
closed after the iterator exits.
A class representing a directory stream.
Created by {@link opendir }, {@link opendirSync }, or `fsPromises.opendir()`.
```js
import { opendir } from 'node:fs/promises';
try {
const dir = await opendir('./');
for await (const dirent of dir)
console.log(dirent.name);
} catch (err) {
console.error(err);
}
```
When using the async iterator, the `fs.Dir` object will be automatically
closed after the iterator exits.closecljs
(close dir)(close dir cb)Asynchronously close the directory's underlying resource handle. Subsequent reads will result in errors.
A promise is returned that will be fulfilled after the resource has been closed.
Parameters:
cb:NoParamCallback
Returns: void
Asynchronously close the directory's underlying resource handle. Subsequent reads will result in errors. A promise is returned that will be fulfilled after the resource has been closed. **Parameters:** - `cb`: `NoParamCallback` **Returns:** `void`
close-synccljs
(close-sync dir)Synchronously close the directory's underlying resource handle. Subsequent reads will result in errors.
Returns: void
Synchronously close the directory's underlying resource handle. Subsequent reads will result in errors. **Returns:** `void`
pathcljs
(path dir)The read-only path of this directory as was provided to {@link opendir },{@link opendirSync }, or fsPromises.opendir().
The read-only path of this directory as was provided to {@link opendir },{@link opendirSync }, or `fsPromises.opendir()`.
readcljs
(read dir)(read dir cb)Asynchronously read the next directory entry via readdir(3) as an fs.Dirent.
A promise is returned that will be fulfilled with an fs.Dirent, or nullif there are no more directory entries to read.
Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results.
Parameters:
cb:(err: ErrnoException | null, dirEnt: Dirent | null) => void
Returns: void
Asynchronously read the next directory entry via [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) as an `fs.Dirent`. A promise is returned that will be fulfilled with an `fs.Dirent`, or `null`if there are no more directory entries to read. Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results. **Parameters:** - `cb`: `(err: ErrnoException | null, dirEnt: Dirent | null) => void` **Returns:** `void`
read-synccljs
(read-sync dir)Synchronously read the next directory entry as an fs.Dirent. See the
POSIX readdir(3) documentation for more detail.
If there are no more directory entries to read, null will be returned.
Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results.
Returns: Dirent | null
Synchronously read the next directory entry as an `fs.Dirent`. See the POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more detail. If there are no more directory entries to read, `null` will be returned. Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results. **Returns:** `Dirent | null`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close