Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A knox wrapper that allows you to use the local file system instead of S3
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
test_files
.gitignore
.jscsrc
.jshintrc
.npmignore
.travis.yml
License.md
README.md
index.js
package.json
test.js
utils.js

README.md

faux-knox

Build Status david-dm

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 read

to 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 write

to is where the buffer is written

headers used by knox module, ignored here

res.headers.statusCode is 200 on successful creation.

deleteFile
function(file, callback)

callback(err, res)

file path in bucket to delete

res.headers.statusCode is 204 on successful deletion.

TODO

All of the other knox functionality

Something went wrong with that request. Please try again.