fs-readdir-promise

Promises/A+ version of fs.readdir

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
fs-readdir-promise
811.0.19 years ago9 years agoMinified + gzip package size for fs-readdir-promise in KB

Readme

fs-readdir-promise
Build Status Build status Coverage Status Dependency Status devDependency Status
Promises/A+Promise version of fs.readdir
var readdir = require('fs-readdir-promise');

readdir('path/to/dir')
.then(function(files) {
  console.log(files);
})
.catch(function(err) {
  console.log(err.message);
});

Installation

NPM version
Use npm.
npm install fs-readdir-promise

API

var readdir = require('fs-readdir-promise');

readdir(path)

path: String
Return: Object (Promise)
When it finish reading the directory, it will be fulfilled with an Array of file names in the directory as its first argument.
When it fails to read the directory, it will be rejected with an error as its first argument.
var readdir = require('fs-readdir-promise');

var onFulfilled = function(files) {
  console.log(files);
};

var onRejected = function(err) {
  console.log('Cannot read the file.');
};

readdir('path/to/file').then(onFulfilled, onRejected);

License

Copyright (c) 2014 Shinnosuke Watanabe
Licensed under the MIT License.