xecio-fs v0.1.0

xecio-fs

File system module for Xecio.

Features

• Support for both Promise and callback interface.
• Use graceful-fs to avoid EMFILE error and various improvements.
• Use chokidar for consistent file watching.

Installation

$ npm install xecio-fs --save

Usage

var fs = require('xecio-fs');

Some methods in the original fs module are not listed below, but they're available in xecio-fs.

exists(path, callback)

Test whether or not the given path exists by checking with the file system.

existsSync(path)

Synchronous version of fs.exists.

mkdirs(path, callback)

Creates a directory and its parent directories if they does not exist.

mkdirsSync(path)

Synchronous version of fs.mkdirs.

writeFile(path, data, options, callback)

Writes data to a file.

writeFileSync(path, data, options)

Synchronous version of fs.writeFile.

appendFile(path, data, options, callback)

Appends data to a file.

appendFileSync(path, data, options)

Synchronous version of fs.appendFile.

copyFile(src, dest, callback)

Copies a file from src to dest.

copyDir(src, dest, options, callback)

Copies a directory from src to dest. It returns an array of copied files.

listDir(path, options, callback)

Lists files in a directory.

listDirSync(path, options)

Synchronous version of fs.listDir.

readFile(path, options, callback)

Reads the entire contents of a file.

readFileSync(path, options)

Synchronous version of fs.readFile.

emptyDir(path, options, callback)

Deletes all files in a directory. It returns an array of deleted files.

emptyDirSync(path, options)

Synchronous version of fs.emptyDir.

rmdir(path, callback)

Removes a directory and all files in it.

rmdirSync(path)

Synchronous version of fs.rmdir.

watch(path, options, callback)

Watches changes of a file or a directory.

See Chokidar API for more info.

ensurePath(path, callback)

Ensures the given path is available to use or appends a number to the path.

ensurePathSync(path)

Synchronous version of fs.ensurePath.

ensureWriteStream(path, options, callback)

Creates the parent directories if they does not exist and returns a writable stream.

ensureWriteStream(path, options)

Synchronous version of fs.ensureWriteStream.

License

MIT