faux-knox


A knox wrapper that allows you to use the local file system instead of S3
Installation
npm install faux-knox
Testing
npm test
API
var knox = process.env.NODE_ENV === 'production'
? require('knox') : require('faux-knox');
var client = knox.createClient({
bucket: 'local/filesystem/dir'
//... other settings
});
//use client everywhere a regular knox client will be used.
Implemented
list
function(options, callback)
callback(err, list)
list
is an object with a Contents array containing the returned files.getFile
function(uri, headers, callback)
callback(err, cres)
cres
is a readable stream with headers attached.putFile
function(from, to, callback)
callback(err, res)
from
is the path to a local file to be readto
is the path to write the from bytes mounted in the bucket specified.res.headers.statusCode
is 200 on successful creation.putBuffer
function(buffer, to, headers, callback)
callback(err, res)
buffer
is the buffer to writeto
is where the buffer is writtenheaders
used by knox module, ignored hereres.headers.statusCode
is 200 on successful creation.deleteFile
function(file, callback)
callback(err, res)
file
path in bucket to deleteres.headers.statusCode
is 204 on successful deletion.