# promised-fs

> Promise based filesystem API for node.

Latest version **0.1.0** (published 2011-02-24) · 0 weekly downloads

## Install

```sh
npm install promised-fs
pnpm add promised-fs
yarn add promised-fs
bun add promised-fs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2011-02-24 |
| First published | 2011-01-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.1.103 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Keywords | promise, filesystem |

## Links

- npm: https://www.npmjs.com/package/promised-fs
- Repository: https://github.com/Gozala/promised-fs
- Homepage: http://github.com/Gozala/promised-fs/
- Issues: http://github.com/Gozala/promised-fs/issues/
- npm.io page: https://npm.io/package/promised-fs

## Dependencies (2)

- [test](https://npm.io/package/test.md) >=0.0.11
- [filesystem-composer](https://npm.io/package/filesystem-composer.md) >=0.1.0

## Recent versions

- 0.1.0 (latest) — 2011-02-24
- 0.0.11 — 2011-02-21
- 0.0.10 — 2011-02-17
- 0.0.9 — 2011-02-17
- 0.0.1 — 2011-01-28
- 0.0.2 — 2011-01-28
- 0.0.3 — 2011-01-28
- 0.0.4 — 2011-01-28
- 0.0.5 — 2011-01-28
- 0.0.6 — 2011-01-28
- 0.0.7 — 2011-01-28
- 0.0.8 — 2011-01-28

## README

promised-fs
===========

Provides `defer/when` style [promise][promise] based filesystem API for
[node.js](http://nodejs.org/). This alternative API allows writing code
in a liniar fasion while still preserving asynchronous behavior.

# Example #

        var fs = require('promised-fs')
        ,   when = require('q').when

        var somePath = fs.workingDirectory().join('someFile.bla')
        var data = fs.read(somePath)
        var wroteTemp = fs.write('/some/path/temp.bla', data)

        when
        ( wroteTemp
        , function resovled() {
            doSomethingNow()
          }
        , function rejected(error) {
            doSomethingElseIfFailed(error)
          }
        )

# Install #

<pre class="console">
npm install promised-fs
</pre>

# Test #

<pre class="console">
npm test promised-fs
</pre>

[promises/b]:http://wiki.commonjs.org/wiki/Promises/B
[promise]:http://en.wikipedia.org/wiki/Futures_and_promises

---
_Source: https://npm.io/package/promised-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._