fspp

fspp - fs-promisified-plus: a Simple Promisified NodeJS.fs Wrapper.

This pakcage is meant to be a quick drop-in replacement for NodeJS module fs.

• All callback functions are promisified with util.promisify.
• Reinterpreted fs.exist with access(path, F_OK).
• All other members from fs inherited including classes, special functions, sync functions and constants.

User story:

This packages is designed and targeted at NodeJS v8.0.0+, with extensive use of async/await calls.

Dependency:

NodeJS v8.0.0 and up (as util.promisify is only provided since v8.0.0). Nothing else.

Basic Usages:

const fs = require(`fspp`);  // Full function of fs module inherited, no need to include both fs and fspp.
// (you stil can require both fs and fspp differently if you want to).

// Promise use example
fs.mkdir(`sample`).then( () => console.log(`sample folder created.`) ).catch(err => console.error(err));

// Async functions example
const main = async () => {
  const data = await fs.readfile(`README.md`, `utf8`); // data = `# fs-promisified-plus...`
  await fs.access(`X:/NON_EXIST_PATH`, fs.constants.R_OK); // This should fail and reject the main promise.
}

// Sync functions example
fs.rmdirSync(`sample`);

Promisified Functions

access, appendFile, chmod, chown, close, exists, fchmod, fchown, fdatasync, fstat, fsync, ftruncate, futimes, link, lstat, mkdir, mkdtemp, open, read, readdir, readFile, readlink, realpath, rename, rmdir, stat, truncate, symlink, unlink, utimes, write, writeFile

ChangeLog

1.1.0 / 2017-07-12

• Simplified implementation.

1.0.4 / 2017-07-10

• Bug-fix, fs.write and fs.writeFile were missing in the promisified function list.

License

Licensed under MIT Copyright (c) 2017 Phoenix Song