Static file server middleware
JavaScript
Latest commit 7deaf2d Feb 26, 2017 @coderhaoxin coderhaoxin update readme
Permalink
Failed to load latest commit information.
test support koa 2.x Mar 24, 2016
.gitignore add coverage Sep 8, 2014
.travis.yml travis - add node v6, v7 Feb 3, 2017
History.md 3.0.0 Mar 24, 2016
Readme.md update readme Feb 26, 2017
example.js support koa 2.x Mar 24, 2016
index.js support koa 2.x Mar 24, 2016
package.json 3.0.0 Mar 24, 2016

Readme.md

koa-static

NPM version Build status Test coverage Dependency Status License Downloads

Koa static file serving middleware, wrapper for koa-send.

Installation

$ npm install koa-static

API

const Koa = require('koa');
const app = new 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 return next(), allowing any downstream middleware to respond first.
  • gzip Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. defaults to true.
  • extensions Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to false)

Example

const serve = require('koa-static');
const Koa = require('koa');
const app = new 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');

See also

License

MIT