Socket
Socket
Sign inDemoInstall

workbox-cacheable-response

Package Overview
Dependencies
1
Maintainers
6
Versions
93
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

workbox-cacheable-response

This library takes a Response object and determines whether it's cacheable based on a specific configuration.


Version published
Maintainers
6
Weekly downloads
4,333,051
increased by2.58%
Install size
359 kB

Weekly downloads

Package description

What is workbox-cacheable-response?

The workbox-cacheable-response npm package is part of the Workbox suite of libraries, which are designed to make it easier to build high-performance web applications with offline capabilities. This particular package provides tools to determine whether responses are cacheable based on certain criteria, such as status codes or headers. It's useful for service workers where you want to ensure that only certain responses are cached.

What are workbox-cacheable-response's main functionalities?

Caching responses based on status codes

This feature allows you to cache responses based on their HTTP status codes. In the code sample, only responses with status codes of 0 (opaque responses) or 200 (OK) are cached. This is particularly useful for caching successful responses or handling CORS requests in service workers.

workbox.routing.registerRoute(
  ({request}) => request.destination === 'image',
  new workbox.strategies.CacheFirst({
    cacheName: 'images',
    plugins: [
      new workbox.cacheableResponse.CacheableResponsePlugin({
        statuses: [0, 200]
      })
    ]
  })
);

Caching responses based on headers

This feature enables caching of responses based on specific header values. In the example, only responses with a header 'X-Is-Cacheable' set to 'true' are considered cacheable. This allows for more granular control over what gets cached, based on server response headers.

workbox.routing.registerRoute(
  ({request}) => request.destination === 'document',
  new workbox.strategies.NetworkFirst({
    cacheName: 'documents',
    plugins: [
      new workbox.cacheableResponse.CacheableResponsePlugin({
        headers: {
          'X-Is-Cacheable': 'true'
        }
      })
    ]
  })
);

Other packages similar to workbox-cacheable-response

Readme

Source

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

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