Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
DamonOehlman committed Dec 17, 2013
0 parents commit eb16e28
Show file tree
Hide file tree
Showing 39 changed files with 1,252 additions and 0 deletions.
72 changes: 72 additions & 0 deletions README.md
@@ -0,0 +1,72 @@
# filestream

A streaming implementation for working with File objects in the browser.


[![NPM](https://nodei.co/npm/filestream.png)](https://nodei.co/npm/filestream/)


## Why

Because the implementations that I found really didn't cut the mustard :/

## Example Usage

Displayed below is an example that uses simple file drag and drop. Rather
than immediately displaying the file, the file is piped through a read
stream into a write stream and then finally displayed in the browser.

```js
var crel = require('crel');
var detect = require('feature/detect');
var dnd = require('drag-and-drop-files');
var img = crel('img');
var FileReadStream = require('filestream/read');
var FileWriteStream = require('filestream/write');

function upload(files) {
var queue = [].concat(files);

function sendNext() {
var writer = new FileWriteStream();

console.log('sending file');
new FileReadStream(queue.shift()).pipe(writer).on('finish', function() {
console.log('file created: ', writer.file);
img.src = detect('URL').createObjectURL(writer.file);
});
}

sendNext();
}

dnd(document.body, upload);

document.body.appendChild(crel('style', 'body, html { margin: 0; width: 100%; height: 100% }'));
document.body.appendChild(img);
```

## License(s)

### MIT

Copyright (c) 2013 Damon Oehlman <damon.oehlman@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
7 changes: 7 additions & 0 deletions docs.json
@@ -0,0 +1,7 @@
{
"badges": {
"nodeico": true
},

"license": {}
}
27 changes: 27 additions & 0 deletions examples/drag-n-drop.js
@@ -0,0 +1,27 @@
var crel = require('crel');
var detect = require('feature/detect');
var dnd = require('drag-and-drop-files');
var img = crel('img');
var FileReadStream = require('../read');
var FileWriteStream = require('../write');

function upload(files) {
var queue = [].concat(files);

function sendNext() {
var writer = new FileWriteStream();

console.log('sending file');
new FileReadStream(queue.shift()).pipe(writer).on('finish', function() {
console.log('file created: ', writer.file);
img.src = detect('URL').createObjectURL(writer.file);
});
}

sendNext();
}

dnd(document.body, upload);

document.body.appendChild(crel('style', 'body, html { margin: 0; width: 100%; height: 100% }'));
document.body.appendChild(img);
23 changes: 23 additions & 0 deletions index.js
@@ -0,0 +1,23 @@
/* jshint node: true */
'use strict';

/**
# filestream
A streaming implementation for working with File objects in the browser.
## Why
Because the implementations that I found really didn't cut the mustard :/
## Example Usage
Displayed below is an example that uses simple file drag and drop. Rather
than immediately displaying the file, the file is piped through a read
stream into a write stream and then finally displayed in the browser.
<<< examples/drag-n-drop.js
**/

exports.read = require('./read');
exports.write = require('./write');
2 changes: 2 additions & 0 deletions node_modules/crel/.npmignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions node_modules/crel/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

130 changes: 130 additions & 0 deletions node_modules/crel/crel.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added node_modules/crel/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions node_modules/crel/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit eb16e28

Please sign in to comment.