koa-static

koa-static

Static file serving middleware.

Installation

$ npm install koa-static

API

var koa = require('koa');
var app = koa();
app.use(require('koa-static')(root, opts));

• root root directory string. nothing above this root directory can be served
• opts options object.

Options

• maxage Browser cache max-age in milliseconds. defaults to 0
• hidden Allow transfer of hidden files. defaults to false
• index Default file name, defaults to 'index.html'
• defer If true, serves after yield next, allowing any downstream middleware to respond first.

Example

var serve = require('koa-static');
var koa = require('koa');
var app = koa();

// $ GET /package.json
app.use(serve('.'));

// $ GET /hello.txt
app.use(serve('test/fixtures'));

// or use absolute paths
app.use(serve(__dirname + '/test/fixtures'));

app.listen(3000);

console.log('listening on port 3000');

License

MIT