This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 1,000,000+ packages pre-installed, including
koa-static with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
Koa static file serving middleware, wrapper for
$ npm install koa-static
const Koa = require('koa'); const app = new Koa(); app.use(require('koa-static')(root, opts));
rootroot directory string. nothing above this root directory can be served
maxageBrowser cache max-age in milliseconds. defaults to 0
hiddenAllow transfer of hidden files. defaults to false
indexDefault file name, defaults to 'index.html'
deferIf true, serves after
return next(), allowing any downstream middleware to respond first.
gzipTry 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.
brTry 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.
extensionsTry to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to
const serve = require('koa-static'); 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');
koa-staticto a specific path