README-zh_CN.md

koa-historify 💫

正确设置 HTML5 History-API 的 Koa2 中间件

English | 中文

为什么

有别于目前依赖 koa-static fallback 的解决方案，本项目使用“默认路由”的思想来将未处理的 GET 请求重定向到 index.html 上。这种解决方案带来了更少的配置项和更直观的使用方式。

安装

npm install koa-historify --save

或者

yarn add koa-historify

使用

// ...
const koaHistorify = require('koa-historify')
const indexPath = path.join(
  __dirname,
  'static/index.html' /* index.html 路径 */
)

const app = new Koa()
// ...
// 确保在其它中间件之后使用，否则请使用 `prepose` 模式
app.use(koaHistorify(indexPath))
app.listen(80)

配置选项

logger

你可以传入一个函数来记录日志

app.use(
  koaHistorify(indexPath, {
    logger: console.log.bind(console)
  })
)

prepose

在 prepose 模式下，你可以在其他中间件被使用前使用它

// ...
const staticPath = path.join(__dirname, 'static')
const indexPath = path.join(staticPath, 'index.html' /* index.html 路径 */)

const app = new Koa()
app.use(
  koaHistorify(indexPath, {
    prepose: true
  })
)
app.use(koaStatic(staticPath))
app.use(router.routes())
// ...
app.listen(80)

开源许可

MIT