Koa Static Resolver

Koa static file resolver, dirs, default index, path replace, cache, livereload, gzip

Install

1npm install koa-static-resolver --save

Usage

1const Koa = require('koa');
2const KSR = require('koa-static-resolver');
3const app = new Koa();
4app.use(KSR({
5    dirs: ["./static/", "../node_modules/"],
6    defaultIndex: "index.html"
7}));
8app.listen(8080);

cache

1app.use(KSR({
2    dirs: ["./static/"],
3    //server cache (Memory)
4    cache: {},
5    //do NOT cache big size file
6    cacheMaxLength: 10 * 1024 * 1024,
7    //browser cache header: max-age=<seconds>
8    maxAge: 600
9}));

livereload

1app.use(KSR({
2    dirs: ["./static/"],
3    livereload: '\n<script src="/livereload.js"></script>\n'
4}));
5//only inject to .html

gzip

1app.use(KSR({
2    dirs: ["./static/"],
3    cache: {},
4    gzip: true,
5    gzipMinLength: 1024,
6    gzipTypes: [".html", ".css", ".js", ".svg", ".xml"]
7}));
8//require headers with "Accept-Encoding": "gzip"

include/exclude

1app.use(KSR({
2    dirs: ["./static/"],
3    include: ["include/folder", /RegExp/],
4    exclude: ["exclude/folder", /RegExp/]
5}));
6// any files not matched include/folder will be 404 not found
7// any files matched exclude/folder will be 404 not found
8// support RegExp

replace

1app.use(KSR({
2    dirs: ["./static/"],
3    replace: {
4      "from_path": "to_path"
5    }
6}));
7//when request /from_path/some_next_path/, will be replaced with /to_path/some_next_path/ to find out file path

headers

1app.use(KSR({
2    dirs: ["./static/"],
3    headers: {
4      "header_key": "header_value"
5    }
6}));

CHANGELOG

• v1.0.5

  • added test case
  • added types

• v1.0.4

  • added include/exclude match for file path

• v1.0.3

  • fixed cache issue if maxAge=0

• v1.0.2

  • fixed livereload