Read Directory

Reads the contents of a directory.

Installation

1$ npm install utils-fs-read-dir

Usage

1var readdir = require( 'utils-fs-read-dir' );

readdir( path, clbk )

Reads the contents of a directory.

1readdir( __dirname, onRead );
2
3function onRead( error, data ) {
4	if ( error ) {
5		console.error( error );
6	} else {
7		console.log( data );
8	}
9}

readdir.sync( path )

Synchronously reads the contents of a directory.

1var out = readdir.sync( __dirname );
2if ( out instanceof Error ) {
3	throw out;
4}
5console.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

  1var fs = require( 'fs' );
  2
  3var dir = '/path/to/dir';
  4
  5// Check for existence to prevent an error being thrown...
  6if ( fs.existsSync( dir ) ) {
  7	dir = fs.readdirSync( dir );
  8}

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

  1var readdir = require( 'utils-fs-read-dir' );
  2
  3var dir = '/path/to/dir';
  4
  5// Explicitly handle the error...
  6dir = readdir.sync( dir );
  7if ( dir instanceof Error ) {
  8	// You choose what to do...
  9	throw dir;
  10}

Examples

1var readdir = require( 'utils-fs-read-dir' );
2
3// Sync:
4var out = readdir.sync( __dirname );
5// returns <array>
6
7console.log( out instanceof Error );
8// returns false
9
10out = readdir.sync( 'beepboop' );
11// returns <error>
12
13console.log( out instanceof Error );
14// returns true
15
16
17// Async:
18readdir( __dirname, onRead );
19readdir( 'beepboop', onRead );
20
21function onRead( error, data ) {
22	if ( error ) {
23		if ( error.code === 'ENOENT' ) {
24			console.error( 'Directory does not exist.' );
25		} else {
26			throw error;
27		}
28	} else {
29		console.log( data );
30	}
31}

To run the example code from the top-level application directory,

1$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

1$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

1$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

1$ make view-cov

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.