mirror of
https://github.com/honojs/hono.git
synced 2024-11-25 05:07:03 +01:00
Web Framework built on Web Standards
https://hono.dev/
example/basic | ||
src | ||
.gitignore | ||
LICENSE | ||
package.json | ||
README.md | ||
yarn.lock |
Hono
Hono [炎] - Tiny web framework for Cloudflare Workers and others.
const app = Hono()
app.get('/', () => 'Hono!!')
app.fire()
Feature
- Fast - the router is implemented with Trie-Tree structure.
- Tiny - use only standard API.
- Portable - zero dependencies.
- Optimized for Cloudflare Workers.
Install
$ yarn add hono
or
$ npm install hono
Methods
- app.HTTP_METHOD(path, ...callback)
- app.all(path, ...callback)
- app.route(path)
- app.before(...callback)
- app.after(...callback)
Routing
Basic
app.HTTP_METHOD
app.get('/', () => 'GET /')
app.post('/', () => 'POST /')
app.get('/wild/*/card', () => 'GET /wild/*/card')
app.all
app.all('/hello', () => 'ALL Method /hello')
Named Parameter
app.get('/user/:name', (req) => {
const name = req.params('name')
...
})
Regexp
app.get('/post/:date{[0-9]+}/:title{[a-z]+}', (req) => {
const date = req.params('date')
const title = req.params('title')
...
Chained Route
app
.route('/api/book')
.get(() => 'GET /api/book')
.post(() => 'POST /api/book')
.put(() => 'PUT /api/book')
Middleware
const logger = (req, res, next) => {
console.log(`[${req.method}] ${req.url}`)
next()
}
const addHeader = (req, res, next) => {
next()
res.headers.add('X-message', 'This is addHeader middleware!')
}
app = app.use('*', logger)
app = app.use('/message/*', addHeader)
app.get('/message/hello', () => 'Hello Middleware!')
Request
query
app.get('/search', (req) => {
const query = req.query('q')
})
params
app.get('/entry/:id', (req) => {
const id = req.params('id')
})
Related projects
- itty-router https://github.com/kwhitley/itty-router
- Sunder https://github.com/SunderJS/sunder
- goblin https://github.com/bmf-san/goblin
Author
Yusuke Wada https://github.com/yusukebe
License
MIT