Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/choysen/koa-historify
💫 HTML5 History-API middleware for Koa2
https://github.com/choysen/koa-historify
html5-history html5-history-middleware koa koa-historify koa-middleware koa2
Last synced: 4 months ago
JSON representation
💫 HTML5 History-API middleware for Koa2
- Host: GitHub
- URL: https://github.com/choysen/koa-historify
- Owner: CHOYSEN
- License: mit
- Created: 2020-10-01T06:36:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T06:59:27.000Z (11 months ago)
- Last Synced: 2024-03-15T07:52:45.428Z (11 months ago)
- Topics: html5-history, html5-history-middleware, koa, koa-historify, koa-middleware, koa2
- Language: TypeScript
- Homepage:
- Size: 476 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [koa-historify](https://github.com/CHOYSEN/koa-historify) 💫
[![NPM version][npm-img]][npm-url]
[![License][license-image]][license-url]
正确设置 HTML5 History-API 的 Koa2 中间件
[English](https://github.com/CHOYSEN/koa-historify/blob/master/README.md) | 中文
## 为什么
有别于目前依赖 `koa-static` fallback 的解决方案，本项目使用“默认路由”的思想来将未处理的 GET 请求重定向到 `index.html` 上。这种解决方案带来了更少的配置项和更直观的使用方式。
## 安装
```
npm install koa-historify --save
```
或者
```
yarn add koa-historify
```
## 使用
```js
// ...
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
你可以传入一个函数来记录日志
```js
app.use(
koaHistorify(indexPath, {
logger: console.log.bind(console)
})
)
```
### prepose
在 prepose 模式下，你可以在其他中间件被使用前使用它
```js
// ...
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](https://github.com/CHOYSEN/koa-historify/blob/master/LICENSE)
[npm-img]: https://img.shields.io/npm/v/koa-historify?style=flat-square
[npm-url]: https://npmjs.org/package/koa-historify
[license-image]: http://img.shields.io/npm/l/koa-historify?style=flat-square
[license-url]: LICENSE