Skip to content

v4.0.0

Compare
Choose a tag to compare
@kwhitley kwhitley released this 26 May 19:49
· 112 commits to v4.x since this release

This is an extensive v4.x update, bringing a series of quality of life additions, as well as a potentially breaking change for TypeScript users:

!Breaking Changes!

  • TYPES HAVE CHANGED FOR THE ROUTER. The core TypeScript and exposed types for the Router itself have been completely retooled to allow much better, strong type support throughout your routes. Previously this required complex custom setups to work around the lack of internal typing. Now it's included out of the box, but you'll need to follow the instructions.

    This was not an easy change to commit to, but was long overdue. The solution finally settled on allows for a more flexible (yet boiler-platey) approach, or a more rigid one... but allows for many more scenarios than the previous types did.

Other Changes

  • added: nearly all the extras from itty-router-extras have moved in-house to the core library. This library will be deprecated as a result.
  • added: createCors from itty-cors has moved into the core library as well
  • feature: withParams middleware (previously from itty-router-extras) is now possible to use as upstream middleware (e.g. globally) to reduce boilerplate. Previously this was not possible.

Official Documentation Site

We've just launched a itty.dev to house documentation for all the itty projects going forward. Previously, we auto-generated docs from the README, but clearly the documentation needs far outweighed what could feasibly fit within a single long README. See the itty-router section for more details!

See the migration guide for complete details.