JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 679
  • Score
    100M100P100Q106218F
  • License MIT

Static file serving middleware for koa with directory, rewrite and index support

Package Exports

  • koa-static-server

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (koa-static-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

koa-static-server

GitHub license
NPM

static file serving middleware for koa with directory, rewrite and index support

Installation

$ npm install koa-static-server

API

var koa = require('koa')
var app = koa()
app.use(require('koa-static-server')(options))

Options

  • rootDir {string} directory that is to be served
  • rootPath {string} optional rewrite path, (defaults to "/")
  • notFoundFile {string} optional default file to serve if requested static is missing
  • log {boolean} request access log to console
  • last {boolean} don't execute any downstream middleware. (defaults to true)
  • maxage Browser cache max-age in milliseconds. (defaults to 0)
  • hidden Allow transfer of hidden files. (defaults to false)
  • index Name of the index file to serve automatically when visiting root location. (defaults to "index.html", use "" to disable)
  • 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)

Example

See examples for code examples

// example 'web' directory
// web/index.html
// web/file.txt

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

// root index support
// GET /
// returns index.html
// GET /file.txt
// returns file.txt
app.use(serve({rootDir: 'web'}))

// folder support
// GET /web/
// returns /web/index.html
// GET /web/file.txt
// returns /web/file.txt
app.use(serve({rootDir: 'web', rootPath: '/web'}))

// index support
// GET /
// returns /file.txt
app.use(serve({rootDir: 'web', index: 'file.txt'}))

// rewrite support
// GET /web/
// returns 404
// GET /admin
// returns /admin/index.html
app.use(serve({rootDir: 'web', rootPath: '/admin'}))

app.listen(3000)

console.log('listening on port 3000')

Support

License

MIT