Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@nodelib/fs.scandir

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@nodelib/fs.scandir

List files and directories inside the specified directory

  • 4.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
41M
decreased by-1.18%
Maintainers
1
Weekly downloads
 
Created

What is @nodelib/fs.scandir?

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.

What are @nodelib/fs.scandir's main functionalities?

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.');
});

Other packages similar to @nodelib/fs.scandir

Keywords

FAQs

Package last updated on 01 Dec 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc