About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Read Directory

Read the contents of a directory.

Installation

npm install @stdlib/fs-read-dir

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
• To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var readDir = require( '@stdlib/fs-read-dir' );

readDir( path, clbk )

Asynchronously reads the contents of a directory.

readDir( __dirname, onRead );

function onRead( error, data ) {
    if ( error ) {
        console.error( error );
    } else {
        console.log( data );
        // => [...]
    }
}

readDir.sync( path )

Synchronously reads the contents of a directory.

var out = readDir.sync( __dirname );
if ( out instanceof Error ) {
    throw out;
}
console.log( out );
// => [...]

Notes

• The difference between this module and fs.readdirSync() is that fs.readdirSync() will throw if an error is encountered (e.g., if given a non-existent path) and this module will return an error. Hence, the following anti-pattern

  var fs = require( 'fs' );
  
  var dir = '/path/to/dir';
  
  // Check for existence to prevent an error being thrown...
  if ( fs.existsSync( dir ) ) {
      dir = fs.readdirSync( dir );
  }

  can be replaced by an approach which addresses existence via error handling.

  var readDir = require( '@stdlib/fs-read-dir' );
  
  var dir = '/path/to/dir';
  
  // Explicitly handle the error...
  dir = readDir.sync( dir );
  if ( dir instanceof Error ) {
      // You choose what to do...
      throw dir;
  }

Examples

var readDir = require( '@stdlib/fs-read-dir' );

/* Sync */

var out = readDir.sync( __dirname );
// returns <Array>

console.log( out instanceof Error );
// => false

out = readDir.sync( 'beepboop' );
// returns <Error>

console.log( out instanceof Error );
// => true

/* Async */

readDir( __dirname, onRead );
readDir( 'beepboop', onRead );

function onRead( error, data ) {
    if ( error ) {
        if ( error.code === 'ENOENT' ) {
            console.error( 'Directory does not exist.' );
        } else {
            throw error;
        }
    } else {
        console.log( data );
    }
}

---

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/fs-read-dir-cli

Usage

Usage: read-dir [options] <dirpath>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Notes

• Relative paths are resolved relative to the current working directory.
• Errors are written to stderr.
• Directory contents are written to stdout.

Examples

$ read-dir ./../
...
...

---

See Also

• @stdlib/fs-exists: test whether a path exists on the filesystem.
• @stdlib/fs-read-file: read the entire contents of a file.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.