@nodelib/fs.scandir
Advanced tools
Package description
The @nodelib/fs.scandir package is a Node.js library that provides a way to read the contents of a directory with the ability to get detailed information about each entry. It supports both synchronous and asynchronous operations and can handle errors gracefully. It is a low-level package that can be used to build more complex file system utilities.
Asynchronous directory scanning
This feature allows you to asynchronously scan a directory and obtain an array of entries, each representing a file or directory within the scanned directory.
const { scandir } = require('@nodelib/fs.scandir');
scandir('/path/to/directory', (error, entries) => {
if (error) {
console.error(error);
return;
}
entries.forEach((entry) => {
console.log(entry);
});
});Synchronous directory scanning
This feature allows you to synchronously scan a directory and obtain an array of entries, similar to the asynchronous version but blocking the event loop until the operation is complete.
const { scandirSync } = require('@nodelib/fs.scandir');
try {
const entries = scandirSync('/path/to/directory');
entries.forEach((entry) => {
console.log(entry);
});
} catch (error) {
console.error(error);
}Stream-based directory scanning
This feature provides a stream interface for directory scanning, allowing you to process entries as they are read, which can be more memory-efficient for large directories.
const { scandirStream } = require('@nodelib/fs.scandir');
const stream = scandirStream('/path/to/directory');
stream.on('data', (entry) => {
console.log(entry);
});
stream.on('error', (error) => {
console.error(error);
});
stream.on('end', () => {
console.log('Scanning is complete.');
});fs-extra is a package that extends the built-in fs module with additional methods and improvements. It includes methods for directory scanning, but it is a more comprehensive file system utility library.
readdirp is a package that provides recursive directory reading with a stream interface. It is similar to @nodelib/fs.scandir's stream feature but focuses on recursive scanning and filtering.
glob is a package that allows pattern matching for filenames. It can be used to scan directories and filter files based on glob patterns, which is different from the straightforward directory listing provided by @nodelib/fs.scandir.
Readme
List files and directories inside the specified path.
The package is aimed at obtaining information about entries in the directory.
$ npm install @nodelib/fs.scandir
const fsScandir = require('@nodelib/fs.scandir');
fsScandir.scandir('root').then((entries) => {
console.log(entries); // => [{ name: 'name', path: 'root/name', ino: 0, is... }]
});
Returns a Promise<DirEntry[]> for provided path.
Returns a DirEntry[] for provided path.
string | Buffer | URLThe path to scan.
ObjectSee options section for more detailed information.
booleanfalseInclude information (fs.Stats) about the file or not.
booleantruePlease, take a look at description inside the fs.stat package.
booleanfalsePlease, take a look at description inside the fs.stat package.
Function ((name: string) => boolean)nullName-based entries filter.
Function ((entry: DirEntry) => boolean)nullDirEntry-based entries filter.
Function ((a: DirEntry, b: DirEntry) => number)nullSort entries on the basis of DirEntry. Uses the standard sort method.
DirEntry interfacePlease, take a look at types/entry.ts file.
See the Releases section of our GitHub project for changelogs for each release version.
This software is released under the terms of the MIT license.
FAQs
List files and directories inside the specified directory
We found that @nodelib/fs.scandir demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.