Giter Club home page Giter Club logo

fs-extra-promise's Introduction

fs-extra-promise.js

Node file system library and fs-extra module promisified with bluebird

Current status

NPM version Build Status Dependency Status Dev dependency Status Coverage Status

API is stable. No tests at present but it seems to work fine!

Usage

This module is a drop-in replacement for the native node file system module and the augmented fs-extra module.

Additionally, it creates promisified versions of all fs's and fs-extra's async methods, using bluebird. These methods are named the same as the original fs/fs-extra methods with 'Async' added to the end of the method names.

So instead of:

var fs = require('fs');
fs.readFile(path, function(err, data) {
	console.log(data);
});

You can now:

var fs = require('fs-extra-promise');
fs.readFileAsync(path).then(function(data) {
	console.log(data);
});

All original fs and fs-extra methods are included unmodified.

isDirectory() methods

For convenience, additional methods isDirectory(), isDirectorySync() and isDirectoryAsync() are provided.

These are are shortcuts for doing fs.stat() followed by running isDirectory() on the result returned by stat().

usePromise() method

Creates a new instance of fs-extra-promise, which uses the Promise implementation provided.

var Bluebird = require('bluebird');
var fs = require('fs-extra-promise').usePromise(Bluebird);

// now use `fs-extra-promise` in the usual way
var promise = fs.readFileAsync(path);

console.log(promise instanceof Bluebird); // true

This can be useful for:

  • using a different version of bluebird
  • using a Promise implementation that supports cls
  • using an augmented version of Bluebird like bluebird-extra

useFs() method

Creates a new instance of fs-extra-promise, promisifying the provide version of fs-extra.

Most useful if you want to use a specific version of fs-extra.

var fs = require('fs-extra-promise').useFs(require('fs-extra'));

Tests

Use npm test to run the tests. Use npm run cover to check coverage.

There aren't any tests at present, except for running jshint on the code.

Changelog

See changelog.md

Issues

If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/fs-extra-promise/issues

fs-extra-promise's People

Contributors

overlookmotel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.