mirrors/hono: Web Framework built on Web Standards - hono

mirror of https://github.com/honojs/hono.git synced 2024-11-25 13:19:30 +01:00

Web Framework built on Web Standards https://hono.dev/

hono

Go to file

Andrew a654842d56 fix(client/types): make args param optional if the input has no required keys (#1618 ) * feat(types.ts): add RequiredKeysOf and HasRequiredKeys utility types * fix(client/types.ts): make args param optional if input has no required keys * chore(types.ts): move RequiredKeysOf and HasRequiredKeys types to utils/types.ts * chore(types.ts): rewrite ClientRequest type * chore(types.ts): fix formatting * chore(types.ts): denoify		2023-10-26 18:07:25 +09:00
.devcontainer	feat: add devcontainer to improve developer experience (#1100 )	2023-09-19 06:47:24 +09:00
.github	chore(ci): bun v1 (#1599 )	2023-10-20 18:18:05 +09:00
.vscode
benchmarks	chore(benchmark): add memoirist router (#1474 )	2023-09-17 09:08:59 +09:00
deno_dist	fix(client/types): make args param optional if the input has no required keys (#1618 )	2023-10-26 18:07:25 +09:00
docs	docs: add a svg logo image (#1217 )	2023-07-04 18:45:55 +09:00
runtime_tests	chore(ci): bun v1 (#1599 )	2023-10-20 18:18:05 +09:00
src	fix(client/types): make args param optional if the input has no required keys (#1618 )	2023-10-26 18:07:25 +09:00
.eslintrc.cjs	chore: update eslint (#1060 )	2023-05-02 18:45:21 +09:00
.gitignore	feat: improvements to secure headers middleware (#1395 )	2023-09-03 07:51:36 +09:00
.prettierrc
build.ts	fix(build): fix ESM support in Node.js / use `esbuild` (#631 )	2022-10-28 08:46:02 +09:00
jest.config.js	chore: tweak `jest.config.js` (#1274 )	2023-07-28 16:26:04 +09:00
LICENSE	chore: update license, contributors as the copyright holders (#769 )	2023-01-02 19:18:59 +09:00
package.cjs.json	fix(typo): `package.cjs.json` target to type (#634 )	2022-10-29 16:09:32 +09:00
package.json	fix: combine fluent interface with route grouping (#1610 )	2023-10-23 05:26:38 +09:00
README.md	chore(benchmark): update the handle-event benchmark (#1297 )	2023-08-05 23:37:41 +09:00
tsconfig.build.json	fix package.json & tsconfig.build.json (#747 )	2022-12-27 22:59:23 +09:00
tsconfig.json	fix(types): don't use webworker types (#1548 )	2023-10-06 05:14:16 +09:00
vitest.config.ts	test: use Node.js Native Web APIs instead of miniflare's (#1558 )	2023-10-10 21:32:10 +09:00
yarn.lock	chore: bump up denoify (#1570 )	2023-10-13 08:59:27 +09:00

README.md

Documentation 👉 hono.dev
v3 has been released! Migration guide

Hono - [炎] means flame🔥 in Japanese - is a small, simple, and ultrafast web framework for the Edges. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Vercel, Lagon, AWS Lambda, Lambda@Edge, and Node.js.

Fast, but not only fast.

import { Hono } from 'hono'
const app = new Hono()

app.get('/', (c) => c.text('Hono!'))

export default app

Quick Start

npm create hono@latest my-app

Features

Ultrafast 🚀 - The router RegExpRouter is really fast. Not using linear loops. Fast.
Lightweight 🪶 - The hono/tiny preset is under 12kB. Hono has zero dependencies and uses only the Web Standard API.
Multi-runtime 🌍 - Works on Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Lagon, AWS Lambda, Lambda@Edge, or Node.js. The same code runs on all platforms.
Batteries Included 🔋 - Hono has built-in middleware, custom middleware, and third-party middleware. Batteries included.
Delightful DX 🛠️ - Super clean APIs. First-class TypeScript support. Now, we've got "Types".

Benchmarks

Hono is the fastest, compared to other routers for Cloudflare Workers.

Hono x 510,171 ops/sec ±4.61% (82 runs sampled)
itty-router x 285,810 ops/sec ±4.13% (85 runs sampled)
sunder x 345,272 ops/sec ±4.46% (87 runs sampled)
worktop x 203,468 ops/sec ±3.03% (91 runs sampled)
Fastest is Hono
✨  Done in 28.68s.

Documentation

The documentation is available on hono.dev.

Migration

The migration guide is available on docs/MIGRATION.md.

Communication

Twitter and Discord channel are available.

Contributing

Contributions Welcome! You can contribute in the following ways.

Create an Issue - Propose a new feature. Report a bug.
Pull Request - Fix a bug and typo. Refactor the code.
Create third-party middleware - Instruct below.
Share - Share your thoughts on the Blog, Twitter, and others.
Make your application - Please try to use Hono.

For more details, see docs/CONTRIBUTING.md.

Contributors

Thanks to all contributors!

Authors

Yusuke Wada https://github.com/yusukebe

RegExpRouter, SmartRouter, LinearRouter, and PatternRouter are created by Taku Amano https://github.com/usualoma

License

Distributed under the MIT License. See LICENSE for more information.