1.0.2 • Published 4 years ago

koa-static-middle v1.0.2

Weekly downloads
1
License
ISC
Repository
github
Last release
4 years ago

koa-static-middle

A Static Middleware based on Koa

installation

$ npm install koa-static-middle

Api

  const koa = require("koa");
  const app = new koa();
  const static = require("koa-static-middle");
  app.use(static(root,Opts));
  app.listen(80);
  • rootroot directory string. this is neccessary!!!
  • optsoptions Object

Opts

  • maxAgeBrowser cache max-age in milliseconds. defaults to 0
  • indexDefault file name, defaults to 'index.html'
  • resHeaderResponse header,defaults to '{}'

Example

  const koa = require("koa");
  const app = new koa();
  const static = require("koa-static-middle");
  //opts is {}
  app.use(static("./static"));

  //default file is index.txt
  app.use(static("./static",{index:"index.txt"}));

  //maxAge is 10
  app.use(static("./static"),{maxAge:10});

  //set resHeader,this is used by ctx.set()
  app.use(static("./static",{resHeader:{"Cache-Control":"public","ETag":123}}));

  //if opts.index is index.html, then http://127.0.0.1 will visit the path "./static/index.html"
  app.listen(80);

License

ISC