fse

fs: then-ified, extended, and dependency-free


Keywords
fs, then, thenified, promiseified, promisified, promises, promised, promise, extends, extended, extend, files, file, system, read, write, remove, copy, touch, json, directory, windows, macos, linux
License
CC0-1.0
Install
npm install fse@1.0.0

Documentation

fse fse

NPM Version Unix Status Windows Status

fse is fs as promises, extended, and dependency-free. It features;

  • Node 4+ compatibility, and;
  • improved fs.mkdir, fs.mkdirSync, fs.rmdir, fs.rmdirSync, fs.writeFile, and fs.writeFileSync methods allowing recursive modification of the file system, and;
  • new fs.copydir, fs.copydirSync, fs.copyFile, fs.copyFileSync, fs.readJson, fs.readJsonSync, fs.touchFile, and fs.touchFileSync methods.

New Methods

fse.copydir

fse.copydir(source, target)
  • source <string> | <Buffer> | <URL>
  • target <string> | <Buffer> | <URL>

Promised copying of the contents of a source directory to a target directory. target may be used to create otherwise non-existent directories.

fse.copyFile

fse.copyFile(source, target)
  • source <string> | <Buffer> | <integer> filename or file descriptor
  • target <string> | <Buffer> | <integer> filename or file descriptor

Promised copying of a source file to a target file, replacing the target file if it already exists. target may be used to create otherwise non-existent directories.

fse.readJson

fse.readJson(path)
  • path <string> | <Buffer> | <integer> filename or file descriptor

Promised reading of the entire contents of a JSON file, constructing the JavaScript value or object described by the file. Resolves as the contents of the file, or rejects with an error.

fse.touchFile

fse.touchFile(path)
  • path <string> | <Buffer> | <integer> filename or file descriptor

Promised existence of a file, creating the file if it does not exist. path may be used to create otherwise non-existent directories.


All existing fs methods are available.

Licensing

fse uses the CC0 “No Rights Reserved” license.