empty-dir
Check if a directory is empty.
Last updated 2 years ago by phated .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install empty-dir 
SYNC missed versions from official npm registry.

empty-dir

NPM version Downloads Travis Build Status AppVeyor Build Status Coveralls Status Gitter chat

Check if a directory is empty.

Usage

var emptyDir = require('empty-dir');

// Using an error-back
emptyDir('./', function(err, result) {
  if (err) {
    console.error(err);
  } else {
    console.log('Directory is empty:', result);
  }
});

// Using a Promise
emptyDir('./').then(function(result) {
  console.log('Directory is empty:', result);
});

var result = emptyDir.sync('./test/empty');
console.log('Directory is empty:', result);

API

emptyDir(paths, [filterFunction], [callback])

Takes a path string or array of path strings and returns a Promise. Checks if the given paths are empty and resolves with a boolean indicating if the paths are empty directories. Optionally takes a filter function to filter out files that cause false positives. Also, can take a node-style callback function instead of returning a Promise.

emptyDir.sync(paths, [filterFunction])

Same as the above API but operates and returns synchronously. An error will be thrown.

Filter function

Both async and sync take a filter function as the second argument, to ignore files like .DS_Store on mac or Thumbs.db on windows from causing false-negatives.

var emptyDir = require('empty-dir');

function filter(filepath) {
  return !/(Thumbs\.db|\.DS_Store)$/i.test(filepath);
}

emptyDir('./', filter, function(err, isEmpty) {
  if (err) {
    console.error(err);
  } else {
    console.log('Directory is empty:', isEmpty);
  }
});

var isEmpty = emptyDir.sync('./test/empty', filter);
console.log('Directory is empty:', isEmpty);

Promises

Global promises are required for this module. If you are using a platform that doesn't have promise support, you'll need to polyfill Promise on the global.

global.Promise = require('insert-your-promise-polyfill-here');

var emptyDir = require('empty-dir');

emptyDir('./').then(function(result) {
  console.log('Directory is empty:', result);
});

License

MIT

Current Tags

  • 2.0.0                                ...           latest (2 years ago)

5 Versions

  • 2.0.0                                ...           2 years ago
  • 1.0.0                                ...           3 years ago
  • 0.2.1                                ...           4 years ago
  • 0.2.0                                ...           5 years ago
  • 0.1.0                                ...           7 years ago
Maintainers (2)
Downloads
Today 77
This Week 7,913
This Month 26,080
Last Day 521
Last Week 8,684
Last Month 41,090
Dependencies (0)
None
Dev Dependencies (6)
Dependents (222)

Copyright 2014 - 2016 © taobao.org |