Package Exports

fs-promise

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fs-promise) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fs-promise

Proxies all async fs methods exposing them as ES 2015 (ES6) compatible promises.

Passes all sync methods through as values.

Also exposes to graceful-fs and/or fs-extra methods if they are installed.

Uses any-promise to load preferred Promise implementation.

var fsp = require('fs-promise');

fsp.writeFile(file('hello1'), 'hello world')
  .then(function(){
    return fsp.readFile(file('hello1'), {encoding:'utf8'});
  })
  .then(function(contents){});

Usage

Attempts to load libraries in the following order. The first successful require will be proxied to a Promise based implementation.

fs-extra
graceful-fs
fs from standard library

Detects a Promise implementation using any-promise. If you have a preferred implementation, or are working in an environment without a global implementation, you must explicitly register a Promise implementation and it will be used. See any-promise for details.

Typical installation:

$ npm install --save fs-extra
$ npm install --save fs-promise

Note that fs-extra depends on graceful-fs, so you would get the benefits of both libraries.