Read the contents of a directory.
npm install @stdlib/fs-read-dirAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var readDir = require( '@stdlib/fs-read-dir' );Asynchronously reads the contents of a directory.
readDir( __dirname, onRead );
function onRead( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
// => [...]
}
}Synchronously reads the contents of a directory.
var out = readDir.sync( __dirname );
if ( out instanceof Error ) {
throw out;
}
console.log( out );
// => [...]-
The difference between this module and
fs.readdirSync()is thatfs.readdirSync()will throw if anerroris encountered (e.g., if given a non-existentpath) and this module will return anerror. Hence, the following anti-patternvar 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
errorhandling.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; }
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 );
}
}To use the module as a general utility, install the module globally
npm install -g @stdlib/fs-read-dirUsage: read-dir [options] <dirpath>
Options:
-h, --help Print this message.
-V, --version Print the package version.
- Relative paths are resolved relative to the current working directory.
- Errors are written to
stderr. - Directory contents are written to
stdout.
$ read-dir ./../
...
...@stdlib/fs/exists: test whether a path exists on the filesystem.@stdlib/fs/read-file: read the entire contents of a file.
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.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
