Socket
Socket
Sign inDemoInstall

workbox-routing

Package Overview
Dependencies
1
Maintainers
6
Versions
94
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

workbox-routing

A service worker helper library to route request URLs to handlers.


Version published
Maintainers
6
Weekly downloads
4,268,245
decreased by-7.91%

Weekly downloads

Package description

What is workbox-routing?

The workbox-routing package is part of the Workbox suite of libraries, which are designed to make it easier to build offline-first Progressive Web Apps (PWAs). The workbox-routing module provides tools to intercept network requests and determine how they should be handled, such as serving them from a cache or fetching a response from the network.

What are workbox-routing's main functionalities?

Registering a route

This code registers a route that intercepts requests for images and applies a cache-first strategy, meaning it will serve the images from the cache if available, otherwise it will fetch them from the network and cache them for future use.

workbox.routing.registerRoute(
  ({request}) => request.destination === 'image',
  new workbox.strategies.CacheFirst()
);

Using a custom handler

This code registers a route for requests to an API endpoint. It uses a custom handler to fetch the request from the network and provides an offline fallback response in case the network request fails.

workbox.routing.registerRoute(
  ({url}) => url.pathname.startsWith('/api/'),
  async ({event}) => {
    try {
      return await fetch(event.request);
    } catch (error) {
      return new Response('Offline fallback', { status: 200 });
    }
  }
);

Navigation route

This code registers a navigation route that serves an app shell HTML file for navigation requests, which is useful for single-page applications that want to ensure an app shell is returned for navigational requests.

workbox.routing.registerNavigationRoute(
  workbox.precaching.getCacheKeyForURL('/app-shell.html')
);

Other packages similar to workbox-routing

Readme

Source

This module's documentation can be found at https://developers.google.com/web/tools/workbox/modules/workbox-routing

Keywords

FAQs

Last updated on 31 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc