Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@nodelib/fs.scandir
Advanced tools
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.
List files and directories inside the specified directory.
The package is aimed at obtaining information about entries in the directory.
name
, path
, dirent
and stats
(optional).old
and modern
mode.npm install @nodelib/fs.scandir
import * as fsScandir from '@nodelib/fs.scandir';
fsScandir.scandir('path', (error, stats) => { /* … */ });
Returns an array of plain objects (Entry
) with information about entry for provided path with standard callback-style.
fsScandir.scandir('path', (error, entries) => { /* … */ });
fsScandir.scandir('path', {}, (error, entries) => { /* … */ });
fsScandir.scandir('path', new fsScandir.Settings(), (error, entries) => { /* … */ });
Returns an array of plain objects (Entry
) with information about entry for provided path.
const entries = fsScandir.scandirSync('path');
const entries = fsScandir.scandirSync('path', {});
const entries = fsScandir.scandirSync(('path', new fsScandir.Settings());
true
string | Buffer | URL
A path to a file. If a URL is provided, it must use the file:
protocol.
false
Options | Settings
Settings
classAn Options
object or an instance of Settings
class.
:book: When you pass a plain object, an instance of the
Settings
class will be created automatically. If you plan to call the method frequently, use a pre-created instance of theSettings
class.
A class of full settings of the package.
const settings = new fsScandir.Settings({ followSymbolicLinks: false });
const entries = fsScandir.scandirSync('path', settings);
name
— The name of the entry (unknown.txt
).path
— The path of the entry relative to call directory (root/unknown.txt
).dirent
— An instance of fs.Dirent
class. On Node.js below 10.10 will be emulated by DirentFromStats
class.stats
(optional) — An instance of fs.Stats
class.For example, the scandir
call for tools
directory with one directory inside:
{
dirent: Dirent { name: 'typedoc', /* … */ },
name: 'typedoc',
path: 'tools/typedoc'
}
boolean
false
Adds an instance of fs.Stats
class to the Entry
.
:book: Always use
fs.readdir
without thewithFileTypes
option. ??TODO??
boolean
false
Follow symbolic links or not. Call fs.stat
on symbolic link if true
.
throwErrorOnBrokenSymbolicLink
boolean
true
Throw an error when symbolic link is broken if true
or safely use lstat
call if false
.
pathSegmentSeparator
string
path.sep
By default, this package uses the correct path separator for your OS (\
on Windows, /
on Unix-like systems). But you can set this option to any separator character(s) that you want to use instead.
fs
FileSystemAdapter
By default, the built-in Node.js module (fs
) is used to work with the file system. You can replace any method with your own.
interface FileSystemAdapter {
lstat?: typeof fs.lstat;
stat?: typeof fs.stat;
lstatSync?: typeof fs.lstatSync;
statSync?: typeof fs.statSync;
readdir?: typeof fs.readdir;
readdirSync?: typeof fs.readdirSync;
}
const settings = new fsScandir.Settings({
fs: { lstat: fakeLstat }
});
old
and modern
modeThis package has two modes that are used depending on the environment and parameters of use.
10.10
or when the stats
option is enabledWhen working in the old mode, the directory is read first (fs.readdir
), then the type of entries is determined (fs.lstat
and/or fs.stat
for symbolic links).
stats
option is disabledIn the modern mode, reading the directory (fs.readdir
with the withFileTypes
option) is combined with obtaining information about its entries. An additional call for symbolic links (fs.stat
) is still present.
This mode makes fewer calls to the file system. It's faster.
See the Releases section of our GitHub project for changelog for each release version.
This software is released under the terms of the MIT license.
FAQs
List files and directories inside the specified directory
The npm package @nodelib/fs.scandir receives a total of 31,705,764 weekly downloads. As such, @nodelib/fs.scandir popularity was classified as popular.
We found that @nodelib/fs.scandir demonstrated a not healthy version release cadence and project activity because the last version was released 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 initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.