npm-koa-static

[mowatermelon]

koa-static

官方仓库

https://github.com/koajs/static#readme

官方npm地址

依赖包地址

https://www.npmjs.com/package/koa-static

在线运行地址

https://npm.runkit.com/koa-static

基础介绍

Koa static file serving middleware, wrapper for koa-send.

基础安装

npm install koa-static --save   # npm
yarn add koa-static             # Yarn

基础使用

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');

• root : root directory string. nothing above this root directory can be served

• opts :options object.

参数说明

参数名	参数说明
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.
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.
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)