h3 0.4.1 → 0.4.2

package/README.md

@@ -29,8 +29,11 @@
 # Using npm
 npm install h3
 
-# Using yarn
-yarn add h3
+# Using pnpm
+pnpm add h3
+
+# Using pnpm
+pnpm add h3
 ```
 
 ## Usage

package/dist/index.cjs

@@ -159,6 +159,16 @@ function appendHeader(res, name, value) {
   }
   res.setHeader(name, current.concat(value));
 }
+function isStream(data) {
+  return typeof data === "object" && typeof data.pipe === "function" && typeof data.on === "function";
+}
+function sendStream(res, data) {
+  return new Promise((resolve, reject) => {
+    data.pipe(res);
+    data.on("end", () => resolve(void 0));
+    data.on("error", (error) => reject(createError(error)));
+  });
+}
 
 function useCookies(req) {
   return cookieEs.parse(req.headers.cookie || "");
@@ -280,6 +290,8 @@ function createHandle(stack, options) {
       const type = typeof val;
       if (type === "string") {
         return send(res, val, MIMES.html);
+      } else if (isStream(val)) {
+        return sendStream(res, val);
       } else if (type === "object" || type === "boolean" || type === "number") {
         if (val && val.buffer) {
           return send(res, val);
@@ -361,11 +373,13 @@ exports.defineHandle = defineHandle;
 exports.defineMiddleware = defineMiddleware;
 exports.deleteCookie = deleteCookie;
 exports.isMethod = isMethod;
+exports.isStream = isStream;
 exports.lazyHandle = lazyHandle;
 exports.promisifyHandle = promisifyHandle;
 exports.send = send;
 exports.sendError = sendError;
 exports.sendRedirect = sendRedirect;
+exports.sendStream = sendStream;
 exports.setCookie = setCookie;
 exports.use = use;
 exports.useBase = useBase;

package/dist/index.d.ts

@@ -250,10 +250,12 @@ declare function useMethod(req: IncomingMessage, defaultMethod?: HTTPMethod): HT
 declare function isMethod(req: IncomingMessage, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): boolean;
 declare function assertMethod(req: IncomingMessage, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): void;
 
-declare function send(res: ServerResponse, data: any, type?: string): Promise<unknown>;
+declare function send(res: ServerResponse, data: any, type?: string): Promise<void>;
 declare function defaultContentType(res: ServerResponse, type?: string): void;
-declare function sendRedirect(res: ServerResponse, location: string, code?: number): Promise<unknown>;
+declare function sendRedirect(res: ServerResponse, location: string, code?: number): Promise<void>;
 declare function appendHeader(res: ServerResponse, name: string, value: string): void;
+declare function isStream(data: any): boolean;
+declare function sendStream(res: ServerResponse, data: any): Promise<unknown>;
 
 declare type RouterMethod = Lowercase<HTTPMethod>;
 declare type HandleWithParams = Handle<any, {
@@ -267,4 +269,4 @@ interface Router extends AddRouteShortcuts {
 }
 declare function createRouter(): Router;
 
-export { AddRouteShortcuts, AddWithMethod, App, AppOptions, AppUse, H3Error, Handle, HandleWithParams, InputLayer, InputStack, Layer, LazyHandle, MIMES, Matcher, Middleware, PHandle, Router, RouterMethod, Stack, appendHeader, assertMethod, callHandle, createApp, createError, createHandle, createRouter, defaultContentType, defineHandle, defineMiddleware, deleteCookie, isMethod, lazyHandle, promisifyHandle, send, sendError, sendRedirect, setCookie, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };
+export { AddRouteShortcuts, AddWithMethod, App, AppOptions, AppUse, H3Error, Handle, HandleWithParams, InputLayer, InputStack, Layer, LazyHandle, MIMES, Matcher, Middleware, PHandle, Router, RouterMethod, Stack, appendHeader, assertMethod, callHandle, createApp, createError, createHandle, createRouter, defaultContentType, defineHandle, defineMiddleware, deleteCookie, isMethod, isStream, lazyHandle, promisifyHandle, send, sendError, sendRedirect, sendStream, setCookie, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };

package/dist/index.mjs

@@ -151,6 +151,16 @@ function appendHeader(res, name, value) {
   }
   res.setHeader(name, current.concat(value));
 }
+function isStream(data) {
+  return typeof data === "object" && typeof data.pipe === "function" && typeof data.on === "function";
+}
+function sendStream(res, data) {
+  return new Promise((resolve, reject) => {
+    data.pipe(res);
+    data.on("end", () => resolve(void 0));
+    data.on("error", (error) => reject(createError(error)));
+  });
+}
 
 function useCookies(req) {
   return parse(req.headers.cookie || "");
@@ -272,6 +282,8 @@ function createHandle(stack, options) {
       const type = typeof val;
       if (type === "string") {
         return send(res, val, MIMES.html);
+      } else if (isStream(val)) {
+        return sendStream(res, val);
       } else if (type === "object" || type === "boolean" || type === "number") {
         if (val && val.buffer) {
           return send(res, val);
@@ -339,4 +351,4 @@ function createRouter() {
   return router;
 }
 
-export { H3Error, MIMES, appendHeader, assertMethod, callHandle, createApp, createError, createHandle, createRouter, defaultContentType, defineHandle, defineMiddleware, deleteCookie, isMethod, lazyHandle, promisifyHandle, send, sendError, sendRedirect, setCookie, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };
+export { H3Error, MIMES, appendHeader, assertMethod, callHandle, createApp, createError, createHandle, createRouter, defaultContentType, defineHandle, defineMiddleware, deleteCookie, isMethod, isStream, lazyHandle, promisifyHandle, send, sendError, sendRedirect, sendStream, setCookie, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h3",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Tiny JavaScript Server",
   "repository": "unjs/h3",
   "license": "MIT",
@@ -17,14 +17,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "dev": "jiti ./playground/index.ts",
-    "lint": "eslint --ext ts,mjs,cjs .",
-    "profile": "0x -o -D .profile -P 'autocannon -c 100 -p 10 -d 40 http://localhost:$PORT' ./playground/server.cjs",
-    "release": "yarn lint && yarn test && yarn build && standard-version && npm publish && git push --follow-tags",
-    "test": "vitest run"
-  },
   "dependencies": {
     "cookie-es": "^0.5.0",
     "destr": "^1.1.0",
@@ -51,5 +43,15 @@
     "typescript": "latest",
     "unbuild": "latest",
     "vitest": "latest"
-  }
-}
+  },
+  "packageManager": "pnpm@6.32.3",
+  "scripts": {
+    "build": "unbuild",
+    "dev": "jiti ./playground/index.ts",
+    "lint": "eslint --ext ts,mjs,cjs .",
+    "profile": "0x -o -D .profile -P 'autocannon -c 100 -p 10 -d 40 http://localhost:$PORT' ./playground/server.cjs",
+    "release": "pnpm lint && pnpm test && pnpm build && standard-version && pnpm publish && git push --follow-tags",
+    "test": "vitest run"
+  },
+  "readme": "[![npm downloads](https://img.shields.io/npm/dm/h3.svg?style=flat-square)](https://npmjs.com/package/h3)\n[![version](https://img.shields.io/npm/v/h3/latest.svg?style=flat-square)](https://npmjs.com/package/h3)\n[![bundlephobia](https://img.shields.io/bundlephobia/min/h3/latest.svg?style=flat-square)](https://bundlephobia.com/result?p=h3)\n[![build status](https://img.shields.io/github/workflow/status/unjs/h3/ci/main?style=flat-square)](https://github.com/unjs/h3/actions)\n[![coverage](https://img.shields.io/codecov/c/gh/unjs/h3/main?style=flat-square)](https://codecov.io/gh/unjs/h3)\n[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue?style=flat-square)](https://www.jsdocs.io/package/h3)\n\n> H3 is a minimal h(ttp) framework built for high performance and portability\n\n<!-- ![h3 - Tiny JavaScript Server](.github/banner.svg) -->\n\n## Features\n\n✔️ &nbsp;**Portable:** Works perfectly in Serverless, Workers, and Node.js\n\n✔️ &nbsp;**Compatible:** Support connect/express middleware\n\n✔️ &nbsp;**Minimal:** Small, tree-shakable and zero-dependency\n\n✔️ &nbsp;**Modern:** Native promise support\n\n✔️ &nbsp;**Extendable:** Ships with a set of composable utilities but can be extended\n\n✔️ &nbsp;**Router:** Super fast route matching using [unjs/radix3](https://github.com/unjs/radix3)\n\n## Install\n\n```bash\n# Using npm\nnpm install h3\n\n# Using pnpm\npnpm add h3\n\n# Using pnpm\npnpm add h3\n```\n\n## Usage\n\n```ts\nimport { createServer } from 'http'\nimport { createApp } from 'h3'\n\nconst app = createApp()\napp.use('/', () => 'Hello world!')\n\ncreateServer(app).listen(process.env.PORT || 3000)\n```\n\n<details>\n <summary>Example using <a href=\"https://github.com/unjs/listhen\">listhen</a> for an elegant listener.</summary>\n\n```ts\nimport { createApp } from 'h3'\nimport { listen } from 'listhen'\n\nconst app = createApp()\napp.use('/', () => 'Hello world!')\n\nlisten(app)\n```\n</details>\n\n## Router\n\nThe `app` instance created by `h3` uses a middleware stack (see [how it works](#how-it-works)) with the ability to match route prefix and apply matched middleware.\n\nTo opt-in using a more advanced and convenient routing system, we can create a router instance and register it to app instance.\n\n```ts\nimport { createApp, createRouter } from 'h3'\n\nconst app = createApp()\n\nconst router = createRouter()\n .get('/', () => 'Hello World!')\n .get('/hello/:name', req => `Hello ${req.params.name}!`)\n\napp.use(router)\n```\n\n**Tip:** We can register same route more than once with different methods.\n\nRoutes are internally stored in a [Radix Tree](https://en.wikipedia.org/wiki/Radix_tree) and matched using [unjs/radix3](https://github.com/unjs/radix3).\n\n## More usage examples\n\n```js\n// Handle can directly return object or Promise<object> for JSON response\napp.use('/api', (req) => ({ url: req.url }))\n\n// We can have better matching other than quick prefix match\napp.use('/odd', () => 'Is odd!', { match: url => url.substr(1) % 2 })\n\n// Handle can directly return string for HTML response\napp.use(() => '<h1>Hello world!</h1>')\n\n// We can chain calls to .use()\napp.use('/1', () => '<h1>Hello world!</h1>')\n   .use('/2', () => '<h1>Goodbye!</h1>')\n\n// Legacy middleware with 3rd argument are automatically promisified\napp.use((req, res, next) => { req.setHeader('X-Foo', 'bar'); next() })\n\n// Force promisify a legacy middleware\n// app.use(someMiddleware, { promisify: true })\n\n// Lazy loaded routes using { lazy: true }\n// app.use('/big', () => import('./big'), { lazy: true })\n```\n\n## Utilities\n\nInstead of adding helpers to `req` and `res`, h3 exposes them as composable utilities.\n\n- `useRawBody(req, encoding?)`\n- `useBody(req)`\n- `useCookies(req)`\n- `useCookie(req, name)`\n- `setCookie(res, name, value, opts?)`\n- `deleteCookie(res, name, opts?)`\n- `useQuery(req)`\n- `send(res, data, type?)`\n- `sendRedirect(res, location, code=302)`\n- `appendHeader(res, name, value)`\n- `createError({ statusCode, statusMessage, data? })`\n- `sendError(res, error, debug?)`\n- `defineHandle(handle)`\n- `defineMiddleware(middlware)`\n- `useMethod(req, default?)`\n- `isMethod(req, expected, allowHead?)`\n- `assertMethod(req, expected, allowHead?)`\n\n👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).\n\n## How it works?\n\nUsing `createApp`, it returns a standard `(req, res)` handler function and internally an array called middleware stack. using`use()` method we can add an item to this internal stack.\n\nWhen a request comes, each stack item that matches the route will be called and resolved until [`res.writableEnded`](https://nodejs.org/api/http.html#http_response_writableended) flag is set, which means the response is sent. If `writableEnded` is not set after all middleware, a `404` error will be thrown. And if one of the stack items resolves to a value, it will be serialized and sent as response as a shorthand method to sending responses.\n\nFor maximum compatibility with connect/express middleware (`req, res, next?` signature), h3 converts classic middleware into a promisified version ready to use with stack runner:\n\n- If middleware has 3rd next/callback param, the promise will `resolve/reject` when called\n- If middleware returns a promise, it will be **chained** to the main promise\n- If calling middleware throws an immediate error, the promise will be rejected\n- On `close` and `error` events of res, the promise will `resolve/reject` (to ensure if middleware simply calls `res.end`)\n\n## License\n\nMIT\n"
+}