Serve static file through koa-router
Installation
npm i static-koa-router
yarn add static-koa-router
Usage
Serve(dirPath: string, router: Router, options?: Options)
You simply need to pass the dir path at the first parameter, the router instance (koa-router) at the second parameter and optionaly the options at third parameter.
Options
maxage
Browser cache max-age in milliseconds. defaults to 0hidden
Allow transfer of hidden files. defaults to falseindex
Default file name, defaults to 'index.html'defer
If true, serves afterreturn 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.extensions
Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults tofalse
)- setHeaders Function to set custom headers on response.
Examples
Typescript
;;;; const app = ; const router = prefix: "/public"; ; app; const server = Http; server;
Javascript
const Serve = ;const KoaRouter = ;const Koa = ;const Http = ; const app = ; const router = prefix: "/public"; ; app; const server = Http; server;
See also
koa-static
koa-send
koa-router
License
MIT - Owen Calvin