Hono Builder

Builder pattern for Hono framework. Enables modular routing and optimized bundle sizes for edge runtimes.

Usage

import { honoBuilder } from 'hono-builder'

const builder = honoBuilder()

builder.get('/hello', (c) => c.text('Hello'))

const app = builder.build()
export default app

Methods

HonoBuilder has the following methods.

• builder.build()
• builder.setNotFoundHandler(handler)
• builder.setErrorHandler(handler)

Additionally, HonoBuilder has the routing methods, which have the same interface as Hono.

• builder.HTTP_METHOD([path,]handler|middleware...)
• builder.all([path,]handler|middleware...)
• builder.on(method|method[], path|path[], handler|middleware...)
• builder.use([path,]middleware)
• builder.route(path, [app])
• builder.basePath(path)
• builder.mount(path, anotherApp)

honoBuilder

honoBuilder receives options and type generics like Hono, and generates a Hono instance based on them.

type Bindings = {
  HELLO: string
}

type Env = {
  Bindings: Bindings
}

const options = {
  strict: true
}

const builder = honoBuilder<Env>(options)

const app = builder.build()
// => build Hono<Env>(options)

build()

.build() makes a new Hono instance with the configured routes.

const builder = honoBuilder()

// Define routes
builder.get('/hello', (c) => c.json({ message: 'Hello!' }))

// Build the Hono app
const app = builder.build()

setNotFoundHandler

.setNotFoundHandler() allows you to customize a Not Found Response.

builder.setNotFoundHandler((c) => {
  return c.text('Custom 404 Message', 404)
})

setErrorHandler

.setErrorHandler() handles an error and returns a customized Response.

builder.setErrorHandler((err, c) => {
  console.error(`${err}`)
  return c.text('Custom Error Message', 500)
})

File Layout

There are several ways to structure code using HonoBuilder depending on the situation. Here is a recommended approach, but please note that this is completely optional.

src
├── builder.ts       // Setup HonoBuilder.
├── app.ts           // Import routing files and exports builder.build()
├── routes           // Define routings
│   ├── _404.tsx
│   ├── _error.tsx
│   └── root.tsx
└── server.ts        // Entrypoint of server

For more details, please refer to the examples.

Acknowledgments

This project is built with and inspired by Hono. Special thanks to Yusuke Wada and the Hono contributors for creating such an amazing framework.