This adapter @hono/node-server allows you to run your Hono application on Node.js.
Initially, Hono wasn't designed for Node.js, but with this adapter, you can now use Hono on Node.js.
It utilizes web standard APIs implemented in Node.js version 18 or higher.
It works on Node.js versions greater than 18.x. The specific required Node.js versions are as follows:
18.x => 18.14.1+
19.x => 19.7.0+
20.x => 20.0.0+
Essentially, you can simply use the latest version of each major release.
Installation
You can install it from the npm registry with npm command:
npm install @hono/node-server
Or use yarn:
yarn add @hono/node-server
Usage
Just import @hono/node-server at the top and write the code as usual.
The same code that runs on Cloudflare Workers, Deno, and Bun will work.
import { serve } from '@hono/node-server'import { Hono } from 'hono'const app = new Hono()app.get('/', (c) => c.text('Hono meets Node.js'))serve(app, (info) => { console.log(`Listening on http://localhost:${info.port}`) // Listening on http://localhost:3000})
For example, run it using ts-node. Then an HTTP server will be launched. The default port is 3000.
ts-node ./index.ts
Open http://localhost:3000 with your browser.
Options
port
serve({ fetch: app.fetch, port: 8787, // Port number, default is 3000})
createServer
import { createServer } from 'node:https'import fs from 'node:fs'//...serve({ fetch: app.fetch, createServer: createServer, serverOptions: { key: fs.readFileSync('test/fixtures/keys/agent1-key.pem'), cert: fs.readFileSync('test/fixtures/keys/agent1-cert.pem'), },})
overrideGlobalObjects
The default value is true. The Node.js Adapter rewrites the global Request/Response and uses a lightweight Request/Response to improve performance. If you don't want to do that, set false.
The default value is true. The Node.js Adapter automatically cleans up (explicitly call destroy() method) if application is not finished to consume the incoming request. If you don't want to do that, set false.
If the application accepts connections from arbitrary clients, this cleanup must be done otherwise incomplete requests from clients may cause the application to stop responding. If your application only accepts connections from trusted clients, such as in a reverse proxy environment and there is no process that returns a response without reading the body of the POST request all the way through, you can improve performance by setting it to false.
Most built-in middleware also works with Node.js.
Read the documentation and use the Middleware of your liking.
import { serve } from '@hono/node-server'import { Hono } from 'hono'import { prettyJSON } from 'hono/pretty-json'const app = new Hono()app.get('*', prettyJSON())app.get('/', (c) => c.json({ 'Hono meets': 'Node.js' }))serve(app)
Serve Static Middleware
Use Serve Static Middleware that has been created for Node.js.
import { serveStatic } from '@hono/node-server/serve-static'//...app.use('/static/*', serveStatic({ root: './' }))
If using a relative path, root will be relative to the current working directory from which the app was started.
This can cause confusion when running your application locally.
Imagine your project structure is:
my-hono-project/ src/ index.ts static/ index.html
Typically, you would run your app from the project's root directory (my-hono-project),
so you would need the following code to serve the static folder:
The onNotFound is useful for debugging. You can write a handle for when a file is not found.
app.use( '/static/*', serveStatic({ root: './non-existent-dir', onNotFound: (path, c) => { console.log(`${path} is not found, request to ${c.req.path}`) }, }))
precompressed
The precompressed option checks if files with extensions like .br or .gz are available and serves them based on the Accept-Encoding header. It prioritizes Brotli, then Zstd, and Gzip. If none are available, it serves the original file.
You can use the ConnInfo Helper by importing getConnInfo from @hono/node-server/conninfo.
import { getConnInfo } from '@hono/node-server/conninfo'app.get('/', (c) => { const info = getConnInfo(c) // info is `ConnInfo` return c.text(`Your remote address is ${info.remote.address}`)})
Accessing Node.js API
You can access the Node.js API from c.env in Node.js. For example, if you want to specify a type, you can write the following.
import { serve } from '@hono/node-server'import type { HttpBindings } from '@hono/node-server'import { Hono } from 'hono'const app = new Hono<{ Bindings: HttpBindings }>()app.get('/', (c) => { return c.json({ remoteAddress: c.env.incoming.socket.remoteAddress, })})serve(app)
The APIs that you can get from c.env are as follows.