workbox Files

What's new?

The v2.0.0 introduces a few breaking changes to interfaces, along with bug fixes and new functionality. Please read carefully before upgrading!

Note that all Workbox packages have been tagged with the 2.0.0 version number on npm, regardless of whether they have breaking changes or not.

Breaking changes

workbox-cli

• Move towards using 'workbox' over 'workbox-cli'. The workbox-cli alias for the command line interface is now deprecated, in favor of the preferred workbox alias. Using workbox-cli will log a warning message, and it will be removed as an alias in a future release. Developers are encouraged to switch to using workbox now.

workbox-routing

• No longer register a fetch handler for each Router by default We've made registering a fetch handler optional, allowing developers who want more control to use the Router class from inside any fetch handler. Developers who are using the workbox-routing module directly can call router.addFetchListener() to mimic the previous behavior.

workbox-runtime-caching

• Rename cacheWillMatch to cachedResponseWillBeUsed Developers who have implemented their own Workbox plugins that respond to cacheWillMatch lifecycle events should rename the method they expose to cachedResponseWillBeUsed. Developers using the pre-made plugins do not need to change anything.
• Adds JSDocs for the lifecycle methods, and awaits the return of each. The underlying RequestWrapper object that triggers request lifecycle methods will now always await the methods' return values. No changes should be necessary unless you've implemented your own plugin which returns a Promise and you do not want the RequestWrapper to delay while waiting for it to resolve.

New features

workbox-range-requests

• New library to support Range requests This allows Workbox to honor the Range: request header when fulfilling requests for cached resources. This comes up often when playing back cached media content.

Other changes

workbox-build

• Improved the workbox-build JSDoc

workbox-webpack-plugin

• adding manifest transform for webpack public path