FS Wishlist

Mixins for the Node.JS file system adding the functionality we wish it had.

Lead Maintainer: David Pate

Usage

mixin(fs, [options])

Mixin an implementation of the file system interface.

Options

• mixins Object Optional enables/disables mixins
  • mkdirp Boolean Optional Default: true Controls whether fs.mkdirp(path[, callback])) is mixed in.
  • rmdirp Boolean Optional Default: true Controls whether fs.rmdirp(path[, callback])) is mixed in.
  • readdirp Boolean Optional Default: true Controls whether fs.readdirp(path[, callback])) is mixed in.
  • copyFile Boolean Optional Default: true Controls whether fs.copyFile(sourcePath, destinationPath[, callback])) is mixed in.
  • copyDir Boolean Optional Default: true Controls whether fs.copyDir(sourcePath, destinationPath[, callback])) is mixed in.

var fsWishlist = require('fs-wishlist');
var fs = require('fs');
var xfs = fsWishlist.mixin(fs);

xfs.mkdirp('test/subdirectory/a').then(function() {
  // Test directories created recursively
}, function(reason) {
  // Something went wrong
});

replace([options])

Replace the fs module with an already mixed in vesion of fs.

Options

• mixins Object Optional enables/disables mixins
  • mkdirp Boolean Optional Default: true Controls whether fs.mkdirp(path[, callback])) is mixed in.
  • rmdirp Boolean Optional Default: true Controls whether fs.rmdirp(path[, callback])) is mixed in.
  • readdirp Boolean Optional Default: true Controls whether fs.readdirp(path[, callback])) is mixed in.
  • copyFile Boolean Optional Default: true Controls whether fs.copyFile(sourcePath, destinationPath[, callback])) is mixed in.
  • copyDir Boolean Optional Default: true Controls whether fs.copyDir(sourcePath, destinationPath[, callback])) is mixed in.

require('fs-wishlist').replace();

var fs = require('fs');
fs.readdirp('test').then(function(files) {
  // Files contains all files in the `test` directory
}, function(reason) {
  // Something went wrong
});

Mixins

For all methods callbacks are optional, if provided they will be used otherwise a promise will be returned.

fs.mkdirp(path[, mode][, callback])

Recursively create directories if they don't exist.

var xfs = require('fs-wishlist').replace();

xfs.mkdirp('/one/two/three').then(function() {
  // Directories created
}, function(reason) {
  // Something went wrong!
});

fs.rmdirp(path[, callback])

Recursively removes the given directory.

var xfs = require('fs-wishlist').replace();

xfs.rmdirp('/one').then(function() {
  // All directories and files removed from `/one` and below
}, function(reason) {
  // Something went wrong!
});

fs.readdirp(path[, callback])

Recursively reads the given directory.

var xfs = require('fs-wishlist').replace();

xfs.readdirp('/one').then(function(files) {
  // `files` contains a list of all files and directories in `/one` recursively
}, function(reason) {
  // Something went wrong!
});

fs.copyFile(sourcePath, destinationPath[, options][, callback])

Copies a file from the source to the destination, creates the destination directories if they do not exist.

var xfs = require('fs-wishlist').replace();

xfs.copyFile('/one/file.txt', '/two/anotherFile.txt').then(function() {
  // Directory `/two` created, and `file.txt` copied over to the new location with the new name
}, function(reason) {
  // Something went wrong!
});

fs.copyDir(sourcePath, destinationPath[, callback])

Recursively copies the contents of a directory to the destination, creates the destination directories if they do not exist. This overwrites the files if they already exist, and directories themselves are not copied but instead a new directory is created of the same name.

var xfs = require('fs-wishlist').replace();

xfs.copyDir('/one', '/two').then(function() {
  // All of the same directories created in the destination and the files are copied recursively
}, function(reason) {
  // Something went wrong!
});