node package manager

Introducing npm Enterprise add-ons. Integrate third-party dev tools into npm…


Mock requests to knox module using file system


[] (

A knox wrapper that allows you to use the local file system instead of S3

npm install faux-knox

npm test

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. 
function(options, callback)
callback(err, list)

list is an object with a Contents array containing the returned files.

function(uri, headers, callback)
callback(err, cres)

cres is a readable stream with headers attached.

function(from, to, callback)
callback(err, res)

from is the path to a local file to be read

to is the path to write the from bytes mounted in the bucket specified.

res.headers.statusCode is 200 on successful creation.

function(buffer, to, headers, callback)
callback(err, res)

buffer is the buffer to write

to is where the buffer is written

headers used by knox module, ignored here

res.headers.statusCode is 200 on successful creation.

function(file, callback)
callback(err, res)

file path in bucket to delete

res.headers.statusCode is 204 on successful deletion.

All of the other knox functionality