itty-router 2.4.4 → 2.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -0
- package/README.md +11 -9
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
## Changelog
|
|
2
2
|
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.
|
|
3
3
|
|
|
4
|
+
- **v2.4.6** - fixed README issues
|
|
4
5
|
- **v2.4.1** - fixed type errors introduced with 2.4.0
|
|
5
6
|
- **v2.4.0** - HUGE internal code-golfing refactor thanks to [@taralx](https://github.com/taralx)! Super cool work on this!!!
|
|
6
7
|
- **v2.3.10** - fix: dots now properly escaped (e.g. /image.jpg should not match /imageXjpg)
|
package/README.md
CHANGED
|
@@ -21,7 +21,9 @@
|
|
|
21
21
|
|
|
22
22
|
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.
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
### Addons & Related Libraries
|
|
25
|
+
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)!
|
|
26
|
+
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).
|
|
25
27
|
|
|
26
28
|
## Features
|
|
27
29
|
- [x] Tiny ([~4xx bytes](https://bundlephobia.com/package/itty-router) compressed) with zero dependencies.
|
|
@@ -196,7 +198,7 @@ GET /todos/jane?limit=2&page=1
|
|
|
196
198
|
const missingHandler = new Response('Not found.', { status: 404 })
|
|
197
199
|
|
|
198
200
|
// create a parent router
|
|
199
|
-
const parentRouter = Router({ base: '/api' )
|
|
201
|
+
const parentRouter = Router({ base: '/api' })
|
|
200
202
|
|
|
201
203
|
// and a child router (with FULL base path defined, from root)
|
|
202
204
|
const todosRouter = Router({ base: '/api/todos' })
|
|
@@ -426,19 +428,19 @@ This trick allows methods (e.g. "get", "post") to by defined dynamically by the
|
|
|
426
428
|
**drastically** reducing boilerplate.
|
|
427
429
|
|
|
428
430
|
[twitter-image]:https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fitty-router
|
|
429
|
-
[logo-image]:https://user-images.githubusercontent.com/865416/
|
|
431
|
+
[logo-image]:https://user-images.githubusercontent.com/865416/146679767-16be95b4-5dd7-4bcf-aed7-b8aa8c828f48.png
|
|
430
432
|
[gzip-image]:https://img.shields.io/bundlephobia/minzip/itty-router
|
|
431
433
|
[gzip-url]:https://bundlephobia.com/result?p=itty-router
|
|
432
434
|
[issues-image]:https://img.shields.io/github/issues/kwhitley/itty-router
|
|
433
435
|
[issues-url]:https://github.com/kwhitley/itty-router/issues
|
|
434
436
|
[npm-image]:https://img.shields.io/npm/v/itty-router.svg
|
|
435
437
|
[npm-url]:http://npmjs.org/package/itty-router
|
|
436
|
-
[travis-image]:https://travis-ci.
|
|
438
|
+
[travis-image]:https://app.travis-ci.com/kwhitley/itty-router.svg?branch=v2.x
|
|
437
439
|
[travis-url]:https://travis-ci.org/kwhitley/itty-router
|
|
438
440
|
[david-image]:https://david-dm.org/kwhitley/itty-router/status.svg
|
|
439
441
|
[david-url]:https://david-dm.org/kwhitley/itty-router
|
|
440
|
-
[coveralls-image]:https://coveralls.io/repos/github/kwhitley/itty-router/badge.svg?branch=
|
|
441
|
-
[coveralls-url]:https://coveralls.io/github/kwhitley/itty-router?branch=
|
|
442
|
+
[coveralls-image]:https://coveralls.io/repos/github/kwhitley/itty-router/badge.svg?branch=v2.x
|
|
443
|
+
[coveralls-url]:https://coveralls.io/github/kwhitley/itty-router?branch=v2.x
|
|
442
444
|
[itty-homepage]:https://itty-router.dev
|
|
443
445
|
[discord-image]:https://img.shields.io/discord/832353585802903572
|
|
444
446
|
[discord-url]:https://discord.com/channels/832353585802903572
|
|
@@ -447,12 +449,12 @@ This trick allows methods (e.g. "get", "post") to by defined dynamically by the
|
|
|
447
449
|
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
|
|
448
450
|
|
|
449
451
|
#### Core, Concepts, and Codebase
|
|
452
|
+
- [@mvasigh](https://github.com/mvasigh) - proxy hack wizard behind itty, coding partner in crime, maker of the entire doc site, etc, etc.
|
|
450
453
|
- [@taralx](https://github.com/taralx) - router internal code-golfing refactor for performance and character savings
|
|
451
454
|
- [@hunterloftis](https://github.com/hunterloftis) - router.handle() method now accepts extra arguments and passed them to route functions
|
|
452
|
-
- [@mvasigh](https://github.com/mvasigh) - proxy hacks courtesy of this chap
|
|
453
455
|
#### Fixes
|
|
454
456
|
- [@taralx](https://github.com/taralx) - QOL fixes for contributing (dev dep fix and test file consistency) <3
|
|
455
457
|
- [@technoyes](https://github.com/technoyes) - three kind-of-a-big-deal errors fixed. Imagine the look on my face... thanks man!! :)
|
|
456
458
|
- [@roojay520](https://github.com/roojay520) - TS interface fixes
|
|
457
|
-
|
|
458
|
-
- [@poacher2k](https://github.com/poacher2k)
|
|
459
|
+
#### Documentation
|
|
460
|
+
- [@arunsathiya](https://github.com/arunsathiya), [@poacher2k](https://github.com/poacher2k), [@ddarkr](https://github.com/ddarkr), [@kclauson](https://github.com/kclauson)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "itty-router",
|
|
3
|
-
"version": "2.4.
|
|
4
|
-
"description": "Tiny, zero-dependency router with route param and query parsing -
|
|
3
|
+
"version": "2.4.8",
|
|
4
|
+
"description": "Tiny, zero-dependency router with route param and query parsing - built for Cloudflare Workers, but works everywhere!",
|
|
5
5
|
"main": "./dist/itty-router.min.js",
|
|
6
6
|
"types": "./dist/itty-router.d.ts",
|
|
7
7
|
"files": [
|