{"_id":"serve-router","_rev":"37-c6939cba9b1411980b127f20979e4449","name":"serve-router","dist-tags":{"latest":"1.1.1"},"versions":{"0.1.0":{"name":"serve-router","version":"0.1.0","author":{"name":"YieldRay"},"license":"ISC","_id":"serve-router@0.1.0","maintainers":[{"name":"yieldray","email":"yieldray@outlook.com"}],"dist":{"shasum":"51c0a3edd3f1e8ad055f59074e24df8b30391c3e","tarball":"https://registry.npmjs.org/serve-router/-/serve-router-0.1.0.tgz","fileCount":8,"integrity":"sha512-kqv8y9D6ZnFx0/N+AcOvwE00d9+0AW4OWYa+wlRSmh1yO6I66LTAENFvNQFWqLALJMwQmD8ndGpSYnadVXgGag==","signatures":[{"sig":"MEUCICAEVV8ErG0MGUANJFWDUY8EKBZy4xwyylKtksYwbI02AiEA1SJZAOCC2Je9zu8mXEPRNA5XkdcBORhz0beVwAq30bo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29312},"main":"dist/main.js","type":"module","scripts":{"build":"rollup -c"},"_npmUser":{"name":"yieldray","email":"yieldray@outlook.com"},"_npmVersion":"9.6.6","description":"a small express like library that routes for your http server \r build for deno's [`serve()`](https://deno.land/std/http/server.ts) api, which is compatible with some serverless platform \r e.g. `cloudflare workers` \r see: Why this is useful? See _[The modern way to write JavaScript servers](https://marvinh.dev/blog/modern-way-to-write-javascript-servers/)_\n\nBuild for Deno's [`Deno.serve()`](https://deno.land/api?s=Deno.serve) api, which is also compatible with some serverless platforms.  \ne.g. [`Bun.serve()`](https://bun.sh/docs/api/http#bun-serve) [`Cloudflare Workers`](https://workers.dev/) [`val.town Web API`](https://www.val.town/v/yieldray.serve_router)   \nsee:   \nNode.js is also supported with built-in polyfill.\n\n**features**:\n\n- Works in any runtime - Node.js, Bun, Deno, Cloudflare Workers, even the web browser!\n- Easy to use with a familiar API\n- Integrate with the existing ecosystem\n- Fully typed\n- Zero dependency\n\n> [!NOTE] \n> For those who are building large web application, [Hono](https://hono.dev/) may be preferred.\n\n# Usage\n\nWe use the [`URL Pattern API`](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) for matching.  \nIt's based on the [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp) library, the one that express depends.  \nFor details, see [the standard](https://urlpattern.spec.whatwg.org/).\n\nFor environments that do not support `URLPattern()`, just import [`urlpattern-polyfill`](https://www.npmjs.com/package/urlpattern-polyfill).\n\nRequirement: support Web Standard API: `Request` `Response`.  \nFor Node.js < 18, this means polyfill is required.\n\n```ts\n// use Deno\nimport ServeRouter from \"https://esm.sh/serve-router@latest\"\nconst { serve } = Deno // Deno >= 1.15 support URLPattern()\n\n// use Node.js >= 18 or Bun\nimport \"urlpattern-polyfill\" // Node.js and Bun do not support URLPattern() currently\nimport ServeRouter from \"serve-router\"\nimport { serve } from \"serve-router/node\" // polyfill for Deno.serve(), not required for bun\n\n// init application (context is optional)\nconst app = ServeRouter()\n\napp.all(\"/\", () => new Response(\"Hello, world!\"))\n\napp.get(\"/headers\", (request: Request) =>\n Response.json(Object.fromEntries(request.headers.entries())),\n)\n\napp.get(\"/user/:name\", (_req, { params }) => {\n // (auto-inferred types)\n // params: { name: string }\n return new Response(`Hello, ${params.name}`)\n // (To disable params infer)\n // app.get(\"/user/:name\" as string, ...)\n})\n\napp.post(\"/post\", async (req) => {\n const json = await req.json()\n return Response.json(json)\n})\n\napp.route(\"/api\") // for /api\n .get(\"\", () => new Response(\"api\")) // for /api/one\n .get(\"/one\", () => new Response(\"one\")) // for /api/two\n .get(\"/two\", () => new Response(\"two\"))\n\napp.use(\"/**\", async (_req, { next }) => {\n const start = Date.now()\n const resp = await next()\n const ms = Date.now() - start\n\n return new Response(resp.body, {\n status: resp.status,\n headers: { ...Object.fromEntries(resp.headers.entries()), \"X-Response-Time\": `${ms}ms` },\n })\n // OR:\n // import { transformResponse } from \"serve-router/utils\"\n // return transformResponse(resp, { headers: { \"X-Response-Time\": `${ms}ms` } })\n})\n\n// Pitfall:\n// if you want to catch all when other route does not match, use app.all()\napp.all(\"/*\", (_req) => {\n return new Response(\"Catch!\", { status: 404 })\n})\n// be aware that code below will override all matched route, which may not be what you want\napp.use(\"/*\", async (_req, { next }) => {\n await next() // run other middlewares\n return new Response(\"Oops!\", { status: 404 }) // returns `Oops!` for any request\n})\n\n// for Deno or Node.js\nserve(app.fetch)\n// for Bun\nBun.serve({ fetch: app.fetch })\n```\n\nIf you only want to run it in Node.js, you can convert it into a Node.js http middleware like this:\n\n```js\nimport \"urlpattern-polyfill\"\nimport { d2n } from \"serve-router/node\"\nconst app = ServeRouter()\napp.get(\"/\", () => new Response(\"Hello, world!\"))\nhttp.createServer(d2n(app.fetch)).listen(8080)\n```\n\nThis library supports CommonJS environment.\n\n```js\nrequire(\"urlpattern-polyfill\")\nconst { d2n, serve } = require(\"serve-router/node\")\nconst { ServeRouter } = require(\"serve-router\")\nconst http = require(\"http\")\nconst app = ServeRouter()\napp.get(\"/\", () => new Response(\"Hello, world!\"))\n\nserve({ handler: app.fetch, port: 8080 })\n// OR:\n// http.createServer(d2n(app.fetch)).listen(8080)\n```\n\nFor `Cloudflare Workers`, `Bun` and `Deno`\n\n```js\nconst app = ServeRouter()\napp.get(\"/\", () => new Response(\"Hello, world!\"))\nexport default {\n fetch: app.fetch,\n}\n```\n\n# Advanced\n\n```ts\n// this example use Deno\nimport ServeRouter from \"npm:serve-router\"\nimport { serveDir } from \"jsr:@std/http/file-server\"\nimport { setCookie, getCookies, type Cookie } from \"jsr:@std/http/cookie\"\n\nconst app = ServeRouter({\n context: { beginTime: Date.now() },\n onError(err) {\n console.log(err)\n },\n})\n// OR: const app = ServeRouter<{ beginTime: number }>()\n\napp.all(\"/static/(.*)\", (req) =>\n serveDir(req, {\n urlRoot: \"static\",\n fsRoot: \"public\",\n }),\n)\n\napp.get(\"/\", async (req) => {\n const cookies: Record = getCookies(req.headers)\n const visitTimes = Number(cookies.visitTimes) || 0\n\n const headers = new Headers()\n const cookie: Cookie = { name: \"visitTimes\", value: String(visitTimes + 1) }\n setCookie(headers, cookie)\n\n return new Response(`Visit ${visitTimes} ${visitTimes > 0 ? \"times\" : \"time\"}!`, { headers })\n})\n\napp.use<{ beginTime: number }>(\"/(.*)\", async (req, ctx) => {\n ctx.beginTime = Date.now()\n console.log(\"[prehandle]  \", req.method, req.url)\n const resp = await ctx.next()\n const endTime = Date.now()\n console.log(\"[posthandle] \", `Returned ${resp.status} in ${endTime - ctx.beginTime}ms`)\n return resp\n})\n\napp.all<{ beginTime: number }>(\"/(.*)\", async (_req, ctx) => {\n return new Response(`Request begins at ${new Date(ctx.beginTime)}`)\n})\n\nDeno.serve(app.fetch)\n```\n\nYes! You can run it in the browser!\n\n```html\n\n```\n\n# Build\n\n```sh\ngit clone https://github.com/YieldRay/serve-router.git\ncd serve-router\npnpm install\npnpm run build\n```\n\n\n\n[npm-version-src]: https://img.shields.io/npm/v/serve-router?style=flat&colorA=080f12&colorB=1fa669\n[npm-version-href]: https://npmjs.com/package/serve-router\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/serve-router?style=flat&colorA=080f12&colorB=1fa669&label=minzip\n[bundle-href]: https://bundlephobia.com/result?p=serve-router\n[license-src]: https://img.shields.io/github/license/YieldRay/serve-router.svg?style=flat&colorA=080f12&colorB=1fa669\n[license-href]: https://github.com/YieldRay/serve-router/blob/main/LICENSE\n[paka-src]: https://img.shields.io/badge/paka-reference-080f12?style=flat&colorA=080f12&colorB=1fa669\n[paka-href]: https://paka.dev/npm/serve-router\n[tsdocs-src]: https://img.shields.io/badge/tsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669\n[tsdocs-href]: https://tsdocs.dev/docs/serve-router\n[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669\n[jsdocs-href]: https://www.jsdocs.io/package/serve-router\n","readmeFilename":"README.md"}