# koa-file-middle

> static file router for koa2

Latest version **1.0.3** (published 2018-08-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install koa-file-middle
pnpm add koa-file-middle
yarn add koa-file-middle
bun add koa-file-middle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-08-16 |
| First published | 2018-07-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | xerysherry |
| Maintainers | xerysherry |
| Keywords | koa, file, router, middle, middleware |

## Links

- npm: https://www.npmjs.com/package/koa-file-middle
- Repository: https://github.com/xerysherry/koa-file-middle
- Homepage: https://github.com/xerysherry/koa-file-middle#readme
- Issues: https://github.com/xerysherry/koa-file-middle/issues
- npm.io page: https://npm.io/package/koa-file-middle

## Dependencies (1)

- [utf8](https://npm.io/package/utf8.md) ^3.0.0

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2018-08-16
- 1.0.2 — 2018-07-11
- 1.0.1 — 2018-07-10
- 1.0.0 — 2018-07-10

## README

koa-file-middle
===============

![npm](https://nodei.co/npm/koa-file-middle.png)

koa中间件，静态文件路由。

如何安装?
--------

```
npm install --save koa-file-middle
```

如何使用?
--------

```Javascript
const koa = require('koa');
const file_router = require('koa-file-middle');

const app = new koa();

app.use(file_router({
    root: '/opt/',
    route: '/',
    // lastmodified: true,
    // maxage: 0,
    // immutable: false,
    // compress: true,
    // showdir: true,
    // extdict: {},
    // page_not_found: ctx=>{}
}));

app.listen(8888);
```

配置说明
------

* root
本地磁盘路径

* route
路由配置

* lastmodified
是否使用Last-Modified属性。默认为false。

* maxage
是否使用缓存机制，单位为秒。大约0秒时，使用Expires，Cache-Control属性。默认为0。

* immutable
是否在Cache-Control中添加immutable属性，默认为false。

* compress
是否使用压缩。默认为false。

* showdir
访问目录时是否列取目录内容。默认false。

* extdict
自定义后缀名返回类型。
```Javascript
app.use(file_router({root: '/opt/', route: '/',
    extdict: {
        '.bin': 'text/html',
    }
}));
```

* page_not_found
自定义访问失败函数。
```Javascript
app.use(file_router({root: '/opt/', route: '/',
    page_not_found: ctx=>{
        ctx.body = 'Page not found';
    }
}));
```

欢迎使用！

---
_Source: https://npm.io/package/koa-file-middle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._