Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.46 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.46 KB

floppy

Version npmBuild StatusDependenciesCoverage Status

Floppy a file representation for assets. It will automatically clean up after it self after all dependent processes eject it.

Installation

The module is written with Browserify and Node.js in mind and is released in the public npm registry. It can be installed by running:

npm install --save floppy

Usage

In all examples we assume that you've required and constructed your floppy instance as following:

'use strict';

var Floppy = require('floppy')
  , file = new Floppy('//cdn.example.org/file.ext');

floppy.eject

Remove a dependent from the floppy. If the floppy is still in use by something it will prevent ejection and return false. Once all the last dependent is removes it self the floppy will be fully eject and call floppy.destroy

floppy.eject();

License

MIT