Skip to content

Commit 440f1ff

Browse files
committed
[M] update README
1 parent 2df9c44 commit 440f1ff

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
55
> Author : Alan Chen
66
7-
> version: 0.0.9
7+
> version: 0.1.0
88
99
> node >= 8.11.1
1010
11-
> Date: 2019/4/25
11+
> Date: 2019/12/4
1212
1313
<div align="center">
1414

@@ -74,9 +74,14 @@
7474
导出一个类,自带1个静态方法`start`。返回一个promise,then表示当前路径是否存在静态文件,会返回文件,reject表示当前路径不存在静态文件,会返回一个Error对象。参数如下:
7575
* IncomingMessage `[可读流]`,Http Server类request事件的第一个参数req
7676
* ServerResponse `[可写流]`,Http Server类request事件的第二个参数res
77-
* opts `[Object]`目前支持两个key。
77+
* opts `[Object]`目前支持:
7878
* rootPath `[String]` 指定文件目录作为服务器根目录,默认为'/',即进程运行的的目录
7979
* homePage `[String]` 当req的url为'/'时跳转的首页文件,默认为'index.html'
80+
* returnContentType `[Boolean]` 是否返回请求对应文件的content-type响应头,默认为true
81+
* gzip `[Boolean]` 是否对静态文件gzip压缩,默认为false
82+
* gzipExclude `[Array<string>]` 忽略gzip压缩的文件后缀名list,默认为[]
83+
84+
> 如果开启了gzip,并且目录里存在原文件和被gzip压缩的文件,则插件不会再次压缩,会直接读取gz文件。这样避免了静态服务器的性能开销。但必须保证原文件存在,例如:`index.html``index.html.gz`
8085
8186
> 基于两个插件实现的express中间件`proxyMiddleware``staticMiddleware`用法同上面类似,可以去[example/express](./example/express/index.js)看详细例子。
8287

0 commit comments

Comments
 (0)