itty-router
Advanced tools
itty-router - npm Package Compare versions
Comparing version 4.0.17 to 4.0.18
| { | ||
| "name": "itty-router", | ||
| "version": "4.0.17", | ||
| "version": "4.0.18", | ||
| "description": "A tiny, zero-dependency router, designed to make beautiful APIs in any environment.", | ||
@@ -5,0 +5,0 @@ "main": "./index.js", |
124
README.md
@@ -52,11 +52,14 @@ <p align="center"> | ||
| Itty aims to be the world's smallest (~440 bytes), feature-rich JavaScript router, enabling beautiful API code with a near-zero bundlesize. Designed originally for [Cloudflare Workers](https://itty.dev/itty-router/runtimes#Cloudflare%20Workers), itty can be used in browsers, Service Workers, edge functions, or standalone runtimes like [Node](https://itty.dev/itty-router/runtimes#Node), [Bun](https://itty.dev/itty-router/runtimes#Bun), etc.! | ||
| Itty is arguably the smallest (~450 bytes) feature-rich JavaScript router available, while enabling dead-simple API code. | ||
| Designed originally for [Cloudflare Workers](https://itty.dev/itty-router/runtimes#Cloudflare%20Workers), itty can be used in browsers, service workers, edge functions, or runtimes like [Node](https://itty.dev/itty-router/runtimes#Node), [Bun](https://itty.dev/itty-router/runtimes#Bun), etc.! | ||
| ## Features | ||
| - Tiny. The Router itself is ~440 bytes gzipped, and the **entire** library is under 1.6k! | ||
| - Easy to use. We believe route code should be self-evident, obvious, and read more like poetry than code. | ||
| - Agnostic. We leave **you** with full control over response types, matching order, upstream/downstream effects, etc. | ||
| - Works [anywhere, in any environment](https://itty.dev/itty-router/runtimes). | ||
| - [Fully typed/TypeScript support](https://itty.dev/itty-router/typescript), including hinting. | ||
| - Tiny, tree-shakeable. [~450](https://deno.bundlejs.com/?q=itty-router/Router) bytes for the Router itself, or [~1.6k](https://bundlephobia.com/package/itty-router) for the entire library (>100x smaller than [express.js](https://www.npmjs.com/package/express)). | ||
| - [Fully-Typed](https://itty.dev/itty-router/typescript). | ||
| - Shorter, simpler route code than most modern routers. | ||
| - Dead-simple [middleware](https://itty.dev/itty-router/middleware) - use ours or write your own. | ||
| - Supports [nested APIs](https://itty.dev/itty-router/nesting). | ||
| - Platform agnostic (based on [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)) - use it [anywhere, in any environment](https://itty.dev/itty-router/runtimes). | ||
| - Parses [route params](https://itty.dev/itty-router/route-patterns#params), | ||
@@ -66,21 +69,9 @@ [optional params](https://itty.dev/itty-router/route-patterns#optional), | ||
| [greedy params](https://itty.dev/itty-router/route-patterns#greedy), | ||
| and [file formats](https://itty.dev/itty-router/route-patterns#file-formats). | ||
| - Automatic [query parsing](https://itty.dev/itty-router/route-patterns#query). | ||
| - Easy [error handling](https://itty.dev/itty-router/errors), including throwing errors with HTTP status codes! | ||
| - Easy [Response](https://itty.dev/itty-router/responses) creation, with helpers for major formats (e.g. | ||
| [json](https://itty.dev/itty-router/api#json), | ||
| [html](https://itty.dev/itty-router/api#html), | ||
| [png](https://itty.dev/itty-router/api#png), | ||
| [jpeg](https://itty.dev/itty-router/api#jpeg), etc.) | ||
| - Deep APIs via [router nesting](https://itty.dev/itty-router/nesting). | ||
| - Full [middleware](https://itty.dev/itty-router/middleware) support. Includes the following by default: | ||
| - [withParams](https://itty.dev/itty-router/api#withParams) - access the params directly off the `Request` (instead of `request.params`). | ||
| - [withCookies](https://itty.dev/itty-router/api#withCookies) - access cookies in a convenient Object format. | ||
| - [withContent](https://itty.dev/itty-router/api#withContent) - auto-parse Request bodies as `request.content`. | ||
| - [CORS](https://itty.dev/itty-router/cors) - because we love you. | ||
| - Fully readable regex... yeah right! 😆 | ||
| [file formats](https://itty.dev/itty-router/route-patterns#file-formats) | ||
| and [query strings](https://itty.dev/itty-router/route-patterns#query). | ||
| - Extremely extendable/flexible. We leave you in complete control. | ||
| ## [Full Documentation](https://itty.dev/itty-router) | ||
| Complete documentation/API is available at [itty.dev](https://itty.dev/itty-router), or join our [Discord](https://discord.com/channels/832353585802903572) channel to chat with community members for quick help! | ||
| Complete API documentation is available at [itty.dev/itty-router](https://itty.dev/itty-router), or join our [Discord](https://discord.com/channels/832353585802903572) channel to chat with community members for quick help! | ||
@@ -133,2 +124,91 @@ ## Installation | ||
| # What's different about itty? <a name="a-different-kind-of-router"></a> | ||
| Itty does a few things very differently from other routers. This allows itty route code to be shorter and more intuitive than most! | ||
| ### 1. Simpler handler/middleware flow. | ||
| In itty, you simply return (anything) to exit the flow. If any handler ever returns a thing, that's what the `router.handle` returns. If it doesn't, it's considered middleware, and the next handler is called. | ||
| That's it! | ||
| ```ts | ||
| // not middleware: any handler that returns (anything at all) | ||
| (request) => [1, 4, 5, 1] | ||
| // middleware: simply doesn't return | ||
| const withUser = (request) => { | ||
| request.user = 'Halsey' | ||
| } | ||
| // a middleware that *might* return | ||
| const onlyHalsey = (request) => { | ||
| if (request.user !== 'Halsey') { | ||
| return error(403, 'Only Halsey is allowed to see this!') | ||
| } | ||
| } | ||
| // uses middleware, then returns something | ||
| route.get('/secure', withUser, onlyHalsey, | ||
| ({ user }) => `Hey, ${user} - welcome back!` | ||
| ) | ||
| ``` | ||
| ### 2. You don't have to build a response in each route handler. | ||
| We've been stuck in this pattern for over a decade. Almost every router still expects you to build and return a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response)... in every single route. | ||
| We think you should be able to do that once, at the end. In most modern APIs for instance, we're serving JSON in the majority of our routes. So why handle that more than once? | ||
| ```ts | ||
| router | ||
| // we can still do it the manual way | ||
| .get('/traditional', (request) => json([1, 2, 3])) | ||
| // or defer to later | ||
| .get('/easy-mode', (request) => [1, 2, 3]) | ||
| // later, when handling a request | ||
| router | ||
| .handle(request) | ||
| .then(json) // we can turn any non-Response into valid JSON. | ||
| ``` | ||
| ### 3. It's all Promises. | ||
| We `await` every handler, looking for a return value. If we get one, we break the flow and return your value. If we don't, we continue processing handlers/routes until we do. This means that every handler can either be synchronous or async - it's all the same. | ||
| When paired with the fact that we can simply return raw data and transform it later, this is AWESOME for working with async APIs, database layers, etc. We don't need to transform anything at the route, we can simply return the Promise (to data) itself! | ||
| Check this out: | ||
| ```ts | ||
| import { myDatabase } from './somewhere' | ||
| router | ||
| // assumes getItems() returns a Promise to some data | ||
| .get('/items', () => myDatabase.getItems()) | ||
| // later, when handling a request | ||
| router | ||
| .handle(request) | ||
| .then(json) // we can turn any non-Response into valid JSON. | ||
| ``` | ||
| ### 4. Only one required argument. The rest is up to you. | ||
| We only require one argument in itty - a Request-like object with the following shape: `{ url, method }` (usually a native [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request)). Because itty is not opinionated about [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) creation, there is not "response" argument built in. Every other argument you pass to `route.handle` is given to each handler, in the same order. | ||
| > ### This makes itty one of the most platform-agnostic routers, *period*, as it's able to match up to any platform's signature. | ||
| Here's an example using [Cloudflare Worker](https://workers.cloudflare.com/) arguments: | ||
| ```ts | ||
| router | ||
| .get('/my-route', (request, environment, context) => { | ||
| // we can access anything here that was passed to `router.handle`. | ||
| }) | ||
| // Cloudflare gives us 3 arguments: request, environment, and context. | ||
| // Passing them to `route.handle` gives every route handler (above) access to each. | ||
| export default { | ||
| fetch: (request, env, ctx) => router | ||
| .handle(request, env, ctx) | ||
| .then(json) | ||
| .catch(error) | ||
| } | ||
| ``` | ||
| ## Join the Discussion! | ||
@@ -135,0 +215,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by8.93%
37015
- Number of lines in readme file
- increased by45.45%
256
No dependency changes