io.filesystem

Monadic wrapper on Node's fs library

Example

( ... )

Installing

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify

$ npm install io.filesystem

Using with CommonJS

If you're not using NPM, Download the latest release, and require the io.filesystem.umd.js file:

var FileSystem = require('io.filesystem')

Using with AMD

Download the latest release, and require the io.filesystem.umd.js file:

require(['io.filesystem'], function(FileSystem) {
  ( ... )
})

Using without modules

Download the latest release, and load the io.filesystem.umd.js file. The properties are exposed in the global Folktale.IO.FileSystem object:

<script src="/path/to/io.filesystem.umd.js"></script>

Compiling from source

If you want to compile this library from the source, you'll need Git, Make, Node.js, and run the following commands:

$ git clone git://github.com/folktale/io.filesystem.git
$ cd io.filesystem
$ npm install
$ make bundle

This will generate the dist/io.filesystem.umd.js file, which you can load in any JavaScript environment.

Documentation

You can read the documentation online or build it yourself:

$ git clone git://github.com/folktale/io.filesystem.git
$ cd io.filesystem
$ npm install
$ make documentation

Then open the file docs/index.html in your browser.

Platform support

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)

Licence

Copyright (c) 2014 Quildreen Motta.

Released under the MIT licence.