JSPM

koa-static-history

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

Static file serving middleware for koa

Package Exports

  • koa-static-history
  • koa-static-history/index.js

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-history) 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-history

fork by koa-static

NPM version Build status Test coverage Dependency Status License Downloads

koa-static-history file serving middleware, wrapper for koa-sents koa-history-api-fallback.

Installation

$ npm install koa-static-history

API

import Koa from "koa"; // CJS: require('koa');
import serve from "koa-static-history"; // CJS: require('koa-static-history')
const app = new Koa();
app.use(serve(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.
  • brotli 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-static-history");
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