Skip to content
Lightweight, dependency-free, promise wrapper around node.js' fs.
JavaScript
Branch: master
Clone or download
This branch is 30 commits ahead, 15 commits behind chrisdothtml:master.

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
src
.eslintignore
.eslintrc.json
.gitignore
.npmignore
.npmrc
CHANGELOG.md
LICENSE
README.md
package-lock.json
package.json
rollup.config.js

README.md

pfs

NPM

npm version

CircleCI

Lightweight, dependency-free, promise wrapper around node.js' fs.

Installation

$ yarn add @haensl/pfs

# or npm
$ npm install -S @haensl/pfs

Use

Exactly how you would use fs. This is a drop-in replacement that converts any callback-based functions to promise-based ones.

const fs = require('@haensl/pfs')

// now uses promise
fs.readFile('my-file.txt', 'utf-8')
  .then((content) => {
    // do nice things
  })
  .catch(...)

// still works the same
fs.readFileSync('my-file.txt', 'utf-8')

// properties are also unchanged
fs.constants.R_OK

Credits

Based on Chris Deacy's pfs.

Changelog

License

You can’t perform that action at this time.