fs-then

Promise aware wrapper for Node's fs module

Usage no npm install needed!

<script type="module">
  import fsThen from 'https://cdn.skypack.dev/fs-then';
</script>

README

fs Then

Build Status

Thin wrapper arround Node's fs module that makes the async functions promise aware. The wrapped methods return a promise the represents the value of the async operation. Traditional callbacks still work, allowing for a transparent drop-in for fs. Sync methods, classes and other helpers are not modified.

Example

Traditional Async

var fs = require('fs-then');
fs.readFile('path to file', function (err, buffer) {
   ...
});

With Promises

var fs = require('fs-then');
fs.readFile('path to file').then(...);

Wrapped methods

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