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

Current Tags

• 5.0.0                                ...           latest (6 years ago)
• 1.5.3                                ...           latest-1 (6 years ago)
• 3.0.0                                ...           next (9 years ago)

27 Versions

• 1.5.3                                ...           6 years ago
• 5.0.0                                ...           6 years ago
• 4.0.3                                ...           6 years ago
• 4.0.2                                ...           7 years ago
• 4.0.1                                ...           7 years ago
• 4.0.0                                ...           7 years ago
• 2.1.0                                ...           8 years ago
• 3.0.0                                ...           9 years ago
• 2.0.0                                ...           9 years ago
• 1.5.2                                ...           9 years ago
• 1.5.1                                ...           9 years ago
• 1.5.0                                ...           9 years ago
• 1.4.9                                ...           10 years ago
• 1.4.8                                ...           10 years ago
• 1.4.7                                ...           10 years ago
• 1.4.6                                ...           10 years ago
• 1.4.5                                ...           11 years ago
• 1.4.4                                ...           11 years ago
• 1.4.3                                ...           11 years ago
• 1.4.2                                ...           11 years ago
• 1.4.1                                ...           11 years ago
• 1.4.0                                ...           11 years ago
• 1.3.0                                ...           11 years ago
• 1.2.0                                ...           11 years ago
• 1.1.1                                ...           11 years ago
• 1.1.0                                ...           11 years ago
• 1.0.0                                ...           11 years ago