GridFS

GridFS made easy.

npm install GridFS
12 downloads in the last week
122 downloads in the last month

GridFS

Simple yet powerful GridFS capabilities built on node-mongodb-native.

Installation:

Install using npm:

npm install GridFS

Then include GridFS in your projects:

var GridFS = require('GridFS').GridFS;
var GridStream = require('GridFS').GridStream;

Tests:

To run the tests:

make tests

Examples:

A simple Hello World example using GridFS.

var GridFS = require('GridFS').GridFS;

// Use the test database
var myFS = new GridFS('test');
var text = new Buffer('Hello World!');

// Functions are performed in the order they are queued
myFS.put(text, 'Hello World!', 'w', function(err){
    if(err) console.log(err);
});

myFS.get('Hello World!',function(err,data){
    console.log(data);
});

// Functions called on a GridFS object after it has closed will be queued to perform
// when it opens again.
myFS.close();

A similar example using GridStream.

var GridStream = require('GridFS').GridStream;

// Use the test database and open or create 'Hello World!'
var writeStream = GridStream.createGridWriteStream('test','Hello World!','w');

writeStream.write('Hello World!');
writeStream.end();

Documentation:

Click here to view the documentation online, or look at the source.

License:

(The MIT License)

Copyright (C) 2013 by Siddharth Mahendraker

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.

npm loves you