# ffs

> A high-level promised wrapper on Node's FS module. For fuck's sake!

Latest version **0.1.2** (published 2013-05-08) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install ffs
pnpm add ffs
yarn add ffs
bun add ffs
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2013-05-08 |
| First published | 2013-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Quildreen "Sorella" Motta |
| Maintainers | killdream |

## Links

- npm: https://www.npmjs.com/package/ffs
- Repository: https://github.com/killdream/ffs
- npm.io page: https://npm.io/package/ffs

## Dependencies (3)

- [pinky](https://npm.io/package/pinky.md) ~0.1.2
- [pinky-for-fun](https://npm.io/package/pinky-for-fun.md) ~0.2.0
- [pinky-combinators](https://npm.io/package/pinky-combinators.md) ~0.1.1

## Recent versions

- 0.1.2 (latest) — 2013-05-08
- 0.1.1 — 2013-03-31
- 0.1.0 — 2013-03-31

## README

# ffs [![Build Status](https://travis-ci.org/killdream/ffs.png)](https://travis-ci.org/killdream/ffs) ![Dependencies Status](https://david-dm.org/killdream/ffs.png)

A high-level promised wrapper on Node's FS module. For fuck's sake!

Everything is curried and promised for your convenience. Take a look at the
`docs/api.doll` file for an overview of the types and functions in the API.


### Example

```js
var ffs         = require('ffs')
var combinators = require('pinky-combinators')
var all         = combinators.all

files = all([ffs.read('a.txt'), ffs.read('b.txt'), ffs.read('c.txt')])
all([ffs.makeRecursive('foo/bar/baz'), files])
 .then(function(xs){ return xs.reduce(function(a,b){ return a + b }, '') })
 .then(ffs.write('utf8', 'foo/bar/baz/'))
```


### Installing

Just grab it from NPM:

    $ npm install ffs


### Documentation

A quick reference of the API can be built using [Calliope][]:

    $ npm install -g calliope
    $ calliope build


### Tests

You can run all tests using Mocha:

    $ npm test


### Licence

MIT/X11. ie.: do whatever you want.

[Calliope]: https://github.com/killdream/calliope
[es5-shim]: https://github.com/kriskowal/es5-shim

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