@hono/node-server 1.19.14 → 2.0.0-rc.2

package/README.md

@@ -1,12 +1,11 @@
 # Node.js Adapter for Hono
 
 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.
+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.
 
 ## Benchmarks
 
-Hono is 3.5 times faster than Express.
+Hono is 4.1 times faster than Express.
 
 Express:
 
@@ -14,12 +13,12 @@ Express:
 $ bombardier -d 10s --fasthttp http://localhost:3000/
 
 Statistics        Avg      Stdev        Max
-  Reqs/sec     16438.94    1603.39   19155.47
-  Latency        7.60ms     7.51ms   559.89ms
+  Reqs/sec     20803.37    1713.06   24910.85
+  Latency        6.01ms     5.21ms   451.37ms
   HTTP codes:
-    1xx - 0, 2xx - 164494, 3xx - 0, 4xx - 0, 5xx - 0
+    1xx - 0, 2xx - 208131, 3xx - 0, 4xx - 0, 5xx - 0
     others - 0
-  Throughput:     4.55MB/s
+  Throughput:     5.75MB/s
 ```
 
 Hono + `@hono/node-server`:
@@ -28,23 +27,17 @@ Hono + `@hono/node-server`:
 $ bombardier -d 10s --fasthttp http://localhost:3000/
 
 Statistics        Avg      Stdev        Max
-  Reqs/sec     58296.56    5512.74   74403.56
-  Latency        2.14ms     1.46ms   190.92ms
+  Reqs/sec     85405.51    7250.65  102658.51
+  Latency        1.46ms     1.00ms   149.95ms
   HTTP codes:
-    1xx - 0, 2xx - 583059, 3xx - 0, 4xx - 0, 5xx - 0
+    1xx - 0, 2xx - 854120, 3xx - 0, 4xx - 0, 5xx - 0
     others - 0
-  Throughput:    12.56MB/s
+  Throughput:    18.49MB/s
 ```
 
 ## Requirements
 
-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.
+It works on Node.js versions greater than 20.x.
 
 ## Installation
 
@@ -77,6 +70,34 @@ serve(app, (info) => {
 })
 ```
 
+## WebSocket
+
+You can upgrade WebSocket connections with `upgradeWebSocket` from `@hono/node-server`.
+To enable this, install `ws` (and `@types/ws`) in your project, then create and provide a `WebSocketServer` as shown in the example below.
+
+```ts
+import { serve, upgradeWebSocket } from '@hono/node-server'
+import { WebSocketServer } from 'ws'
+import { Hono } from 'hono'
+
+const app = new Hono()
+
+app.get(
+  '/ws',
+  upgradeWebSocket(() => ({
+    onMessage(event, ws) {
+      ws.send(event.data)
+    },
+  }))
+)
+
+const wss = new WebSocketServer({ noServer: true }) // important to create with `noServer: true`
+serve({
+  fetch: app.fetch,
+  websocket: { server: wss },
+})
+```
+
 For example, run it using `ts-node`. Then an HTTP server will be launched. The default port is `3000`.
 
 ```sh
@@ -138,6 +159,23 @@ serve({
 })
 ```
 
+### `websocket`
+
+provide a websocket server to enable websocket support.
+
+```ts
+import { serve, upgradeWebSocket } from '@hono/node-server'
+import { WebSocketServer } from 'ws'
+
+// ...
+const wss = new WebSocketServer({ noServer: true })
+
+serve({
+  fetch: app.fetch,
+  websocket: { server: wss },
+})
+```
+
 ## Middleware
 
 Most built-in middleware also works with Node.js.

package/dist/conninfo.cjs

@@ -0,0 +1,22 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/conninfo.ts
+/**
+* ConnInfo Helper for Node.js
+* @param c Context
+* @returns ConnInfo
+*/
+const getConnInfo = (c) => {
+	const bindings = c.env.server ? c.env.server : c.env;
+	const address = bindings.incoming.socket.remoteAddress;
+	const port = bindings.incoming.socket.remotePort;
+	const family = bindings.incoming.socket.remoteFamily;
+	return { remote: {
+		address,
+		port,
+		addressType: family === "IPv4" ? "IPv4" : family === "IPv6" ? "IPv6" : void 0
+	} };
+};
+
+//#endregion
+exports.getConnInfo = getConnInfo;

package/dist/{conninfo.d.ts → conninfo.d.cts}

@@ -1,10 +1,11 @@
-import { GetConnInfo } from 'hono/conninfo';
+import { GetConnInfo } from "hono/conninfo";
 
+//#region src/conninfo.d.ts
 /**
  * ConnInfo Helper for Node.js
  * @param c Context
  * @returns ConnInfo
  */
 declare const getConnInfo: GetConnInfo;
-
-export { getConnInfo };
+//#endregion
+export { getConnInfo };

package/dist/conninfo.d.mts

@@ -1,10 +1,11 @@
-import { GetConnInfo } from 'hono/conninfo';
+import { GetConnInfo } from "hono/conninfo";
 
+//#region src/conninfo.d.ts
 /**
  * ConnInfo Helper for Node.js
  * @param c Context
  * @returns ConnInfo
  */
 declare const getConnInfo: GetConnInfo;
-
-export { getConnInfo };
+//#endregion
+export { getConnInfo };

package/dist/conninfo.mjs

@@ -1,17 +1,20 @@
-// src/conninfo.ts
-var getConnInfo = (c) => {
-  const bindings = c.env.server ? c.env.server : c.env;
-  const address = bindings.incoming.socket.remoteAddress;
-  const port = bindings.incoming.socket.remotePort;
-  const family = bindings.incoming.socket.remoteFamily;
-  return {
-    remote: {
-      address,
-      port,
-      addressType: family === "IPv4" ? "IPv4" : family === "IPv6" ? "IPv6" : void 0
-    }
-  };
-};
-export {
-  getConnInfo
+//#region src/conninfo.ts
+/**
+* ConnInfo Helper for Node.js
+* @param c Context
+* @returns ConnInfo
+*/
+const getConnInfo = (c) => {
+	const bindings = c.env.server ? c.env.server : c.env;
+	const address = bindings.incoming.socket.remoteAddress;
+	const port = bindings.incoming.socket.remotePort;
+	const family = bindings.incoming.socket.remoteFamily;
+	return { remote: {
+		address,
+		port,
+		addressType: family === "IPv4" ? "IPv4" : family === "IPv6" ? "IPv6" : void 0
+	} };
 };
+
+//#endregion
+export { getConnInfo };

package/dist/constants-BLSFu_RU.mjs

@@ -0,0 +1,5 @@
+//#region src/utils/response/constants.ts
+const X_ALREADY_SENT = "x-hono-already-sent";
+
+//#endregion
+export { X_ALREADY_SENT as t };

package/dist/constants-BXAKTxRC.cjs

@@ -0,0 +1,11 @@
+
+//#region src/utils/response/constants.ts
+const X_ALREADY_SENT = "x-hono-already-sent";
+
+//#endregion
+Object.defineProperty(exports, 'X_ALREADY_SENT', {
+  enumerable: true,
+  get: function () {
+    return X_ALREADY_SENT;
+  }
+});