itty-router 2.4.2 → 2.4.6

package/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Changelog
 Until this library makes it to a production release of v1.x, **minor versions may contain breaking changes to the API**.  After v1.x, semantic versioning will be honored, and breaking changes will only occur under the umbrella of a major version bump.
 
+- **v2.4.6** - fixed README issues
 - **v2.4.1** - fixed type errors introduced with 2.4.0
 - **v2.4.0** - HUGE internal code-golfing refactor thanks to [@taralx](https://github.com/taralx)!  Super cool work on this!!!
 - **v2.3.10** - fix: dots now properly escaped (e.g. /image.jpg should not match /imageXjpg)

package/README.md

@@ -19,9 +19,11 @@
   <img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
 </a>-->
 
-It's an itty bitty router, designed for Express.js-like routing within [Cloudflare Workers](https://developers.cloudflare.com/workers/) (or anywhere else). Like... it's super tiny ([~4xx bytes](https://bundlephobia.com/package/itty-router)), with zero dependencies. For reals.
+It's an itty bitty router, designed for express-like routing within [Cloudflare Workers](https://developers.cloudflare.com/workers/) (or anywhere else). Like... it's super tiny ([~4xx bytes](https://bundlephobia.com/package/itty-router)), with zero dependencies. For reals.
 
-For quality-of-life improvements (e.g. middleware, cookies, body parsing, json handling, errors, and an itty version with automatic exception handling), to further shorten your routing code, be sure to check out [itty-router-extras](https://www.npmjs.com/package/itty-router-extras) - also specifically written for API development on [Cloudflare Workers](https://developers.cloudflare.com/workers/)!
+### Addons & Related Libraries
+1. [itty-router-extras](https://www.npmjs.com/package/itty-router-extras) - adds quality-of-life improvements and utility functions for simplifying request/response code (e.g. middleware, cookies, body parsing, json handling, errors, and an itty version with automatic exception handling)!
+2. [itty-durable](https://github.com/kwhitley/itty-durable) - creates a more direct object-like API for interacting with [Cloudflare Durable Objects](https://developers.cloudflare.com/workers/learning/using-durable-objects).
 
 ## Features
 - [x] Tiny ([~4xx bytes](https://bundlephobia.com/package/itty-router) compressed) with zero dependencies.
@@ -33,9 +35,10 @@ For quality-of-life improvements (e.g. middleware, cookies, body parsing, json h
 - [x] [Base path](#nested-routers-with-404-handling) for prefixing all routes.
 - [x] [Multi-method support](#nested-routers-with-404-handling) using the `.all()` channel.
 - [x] Supports **any** method type (e.g. `.get() --> 'GET'` or `.puppy() --> 'PUPPY'`).
+- [x] Supports [Cloudflare ES Module syntax](#cf-es6-module-syntax)! :)
+- [x] [Preload or manually inject custom regex for routes](#manual-routes) (advanced usage)
 - [x] [Extendable](#extending-itty-router). Use itty as the internal base for more feature-rich/elaborate routers.
 - [x] Chainable route declarations (why not?)
-- [x] [Preload or manually inject custom regex for routes](#manual-routes) (advanced usage)
 - [ ] Readable internal code (yeah right...)
 
 ## Installation
@@ -195,7 +198,7 @@ GET /todos/jane?limit=2&page=1
 const missingHandler = new Response('Not found.', { status: 404 })
 
 // create a parent router
-const parentRouter = Router({ base: '/api' )
+const parentRouter = Router({ base: '/api' })
 
 // and a child router (with FULL base path defined, from root)
 const todosRouter = Router({ base: '/api/todos' })
@@ -446,12 +449,12 @@ This trick allows methods (e.g. "get", "post") to by defined dynamically by the
 These folks are the real heroes, making open source the powerhouse that it is!  Help out and get your name added to this list! <3
 
 #### Core, Concepts, and Codebase
+- [@mvasigh](https://github.com/mvasigh) - proxy hack wizard behind itty, coding partner in crime, maker of the entire doc site, etc, etc.
 - [@taralx](https://github.com/taralx) - router internal code-golfing refactor for performance and character savings
 - [@hunterloftis](https://github.com/hunterloftis) - router.handle() method now accepts extra arguments and passed them to route functions
-- [@mvasigh](https://github.com/mvasigh) - proxy hacks courtesy of this chap
 #### Fixes
 - [@taralx](https://github.com/taralx) - QOL fixes for contributing (dev dep fix and test file consistency) <3
 - [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed.  Imagine the look on my face... thanks man!! :)
 - [@roojay520](https://github.com/roojay520) - TS interface fixes
-- [@arunsathiya](https://github.com/arunsathiya) - documentation
-- [@poacher2k](https://github.com/poacher2k) - documentation
+#### Documentation
+- [@arunsathiya](https://github.com/arunsathiya), [@poacher2k](https://github.com/poacher2k), [@kclauson](https://github.com/kclauson)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "itty-router",
-  "version": "2.4.2",
-  "description": "Tiny, zero-dependency router with route param and query parsing - build for Cloudflare Workers, but works everywhere!",
+  "version": "2.4.6",
+  "description": "Tiny, zero-dependency router with route param and query parsing - built for Cloudflare Workers, but works everywhere!",
   "main": "./dist/itty-router.min.js",
   "types": "./dist/itty-router.d.ts",
   "files": [
@@ -11,14 +11,21 @@
   "keywords": [
     "router",
     "cloudflare",
+    "worker",
     "workers",
     "serverless",
+    "api",
     "express",
     "regex",
     "routing",
-    "api",
     "handler",
     "params",
+    "request",
+    "response",
+    "service worker",
+    "sw",
+    "cf",
+    "optional",
     "middleware",
     "nested",
     "rest",