itty-router 2.5.0 → 2.5.1

package/CHANGELOG.md

@@ -1,7 +1,9 @@
 ## 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.
 
-[@SupremeTechnopriest)(https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D
+[@SupremeTechnopriest)(https://github.com/SupremeTechnopriest) - improved TypeScript support and documentation! :D\
+
+- **v2.5.1** - added context to Cloudflare ES module syntax example (credit [@jcapogna](https://github.com/jcapogna))
 - **v2.5.0** - improved TypeScript docs/types (thanks [@SupremeTechnopriest](https://github.com/SupremeTechnopriest)!)
 - **v2.4.9** - fixed the cursed "optional" file format capturing bug - RIP all the bytes lost
 - **v2.4.6** - fixed README issues

package/README.md

@@ -283,16 +283,33 @@ router.get('/todos/:id.:format?', request => {
 ```
 
 ### Cloudflare ES6 Module Syntax (required for Durable Objects) <a id="cf-es6-module-syntax"></a>
+See https://developers.cloudflare.com/workers/runtime-apis/fetch-event#syntax-module-worker
 ```js
+import { Router } from 'itty-router'
+
 const router = Router()
 
-router.get('/', (request, env) => {
+router.get('/', (request, env, context) => {
   // now have access to the env (where CF bindings like durables, KV, etc now are)
 })
 
 export default {
   fetch: router.handle // yep, it's this easy.
 }
+
+// alternative advanced/manual approach for downstream control
+export default {
+  fetch: (...args) => router
+                        .handle(...args)
+                        .then(response => 
+                          // can modify response here before final return, e.g. CORS headers
+
+                          return response
+                        })
+                        .catch(err => {
+                          // and do something with the errors here, like logging, error status, etc
+                        })
+}
 ```
 
 ### Extending itty router
@@ -558,4 +575,8 @@ These folks are the real heroes, making open source the powerhouse that it is!
 - [@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
 #### Documentation
-- [@arunsathiya](https://github.com/arunsathiya), [@poacher2k](https://github.com/poacher2k), [@ddarkr](https://github.com/ddarkr), [@kclauson](https://github.com/kclauson)
+- [@arunsathiya](https://github.com/arunsathiya), 
+  [@poacher2k](https://github.com/poacher2k), 
+  [@ddarkr](https://github.com/ddarkr), 
+  [@kclauson](https://github.com/kclauson),
+  [@jcapogna](https://github.com/jcapogna)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-router",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "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",