1 | # koa-static [![Build Status](https://travis-ci.org/koajs/static.png)](https://travis-ci.org/koajs/static)
|
2 |
|
3 | Static file serving middleware.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | ```js
|
8 | $ npm install koa-static
|
9 | ```
|
10 |
|
11 | ## Options
|
12 |
|
13 | - `maxage` Browser cache max-age in milliseconds. defaults to 0
|
14 | - `hidden` Allow transfer of hidden files. defaults to false
|
15 | - `index` Default file name, defaults to 'index.html'
|
16 | - `defer` If true, serves after `yield next`, allowing any downstream middleware to respond first.
|
17 |
|
18 | ## Example
|
19 |
|
20 | ```js
|
21 | var serve = require('koa-static');
|
22 | var koa = require('koa');
|
23 | var app = koa();
|
24 |
|
25 | // $ GET /package.json
|
26 | app.use(serve('.'));
|
27 |
|
28 | // $ GET /hello.txt
|
29 | app.use(serve('test/fixtures'));
|
30 |
|
31 | // or use absolute paths
|
32 | app.use(serve(__dirname + '/test/fixtures'));
|
33 |
|
34 | app.listen(3000);
|
35 |
|
36 | console.log('listening on port 3000');
|
37 | ```
|
38 |
|
39 | ## License
|
40 |
|
41 | MIT
|