koa-servlets v1.0.0

koa-static

Koa-servlet is a wrapper for koa-send which allows to serve a given file path from a given root.

Installation

$ npm install koa-servlet

API

const Koa = require('koa');
const app = new Koa();
app.use(require('koa-servlets')(servlets, opts));

• servlets is a Map of paths and roots.
• opts options object, which reflects to koa-send options.

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.
• br Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists (note, that brotli is only accepted over https). defaults to true.
• setHeaders Function to set custom headers on response.
• 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-servlets');
const Koa = require('koa');
const app = new Koa();

// $ GET /robots.txt

const servlets = new Map([
  ['/robots.txt', __dirname + '/test/fixtures/robots.txt']
]);

// or use absolute paths
app.use(serve(servlets));

app.listen(3000);

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

See also

• koajs/conditional-get Conditional GET support for koa
• koajs/compress Compress middleware for koa
• koajs/mount Mount koa-static to a specific path

License

MIT