H3

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
[![JSDocs][jsdocs-src]][jsdocs-href]

H3 is a minimal h(ttp) framework built for high performance and portability.

👉 Online Playground

Features

✔️  Portable: Works perfectly in Serverless, Workers, and Node.js

✔️  Minimal: Small and tree-shakable

✔️  Modern: Native promise support

✔️  Extendable: Ships with a set of composable utilities but can be extended

✔️  Router: Super fast route matching using unjs/radix3

✔️  Compatible: Compatibility layer with node/connect/express middleware

Install

``bash


Using npm

npm install h3

Using yarn

yarn add h3

Using pnpm

pnpm add h3
`

Using Nightly Releases

If you are directly using h3 as a dependency:

`json
{
"dependencies": {
"h3": "npm:h3-nightly@latest"
}
}
`

If you are using a framework (Nuxt or Nitro) that is using h3:

pnpm and yarn:

`json
{
"resolutions": {
"h3": "npm:h3-nightly@latest"
}
}
`

npm:

`json
{
"overrides": {
"h3": "npm:h3-nightly@latest"
}
}
`

Note: Make sure to recreate lockfile and node_modules after reinstall to avoid hoisting issues.

Usage

`ts
import { createServer } from "node:http";
import { createApp, eventHandler, toNodeListener } from "h3";

const app = createApp();
app.use(
"/",
eventHandler(() => "Hello world!"),
);

createServer(toNodeListener(app)).listen(process.env.PORT || 3000);
`

Example using listhen for an elegant listener:

`ts
import { createApp, eventHandler, toNodeListener } from "h3";
import { listen } from "listhen";

const app = createApp();
app.use(
"/",
eventHandler(() => "Hello world!"),
);

listen(toNodeListener(app));
`

Router

The app instance created by h3 uses a middleware stack (see how it works) with the ability to match route prefix and apply matched middleware.

To opt-in using a more advanced and convenient routing system, we can create a router instance and register it to app instance.

`ts
import { createApp, eventHandler, createRouter } from "h3";

const app = createApp();

const router = createRouter()
.get(
"/",
eventHandler(() => "Hello World!"),
)
.get(
"/hello/:name",
eventHandler((event) => Hello ${event.context.params.name}!),
);

app.use(router);
`

Tip: We can register the same route more than once with different methods.

Routes are internally stored in a Radix Tree and matched using unjs/radix3.

For using nested routers, see this example

More app usage examples

`js
// Handle can directly return object or Promise