Get Inspired
Docs
Blog
Articles
Workbox
Service worker overview A service worker's life Strategies for service worker caching What is Workbox?
Expectations around service worker deployment Removing buggy service workers Improving the service worker development experience Troubleshooting and logging Different service worker strategies for different architectures Service workers and the application shell model Navigation Preload for Network-first HTML Faster multipage applications with streams Precaching dos and don'ts Understanding storage quota
The ways of Workbox Precaching with Workbox Using Workbox without precaching Framework integrations
Using workbox-window Caching resources during runtime Forcing a network timeout Access caches from the window Serving cached audio and video Managing fallback responses Handling service worker updates with immediacy Retrying requests when back online Using plugins
Workbox Modules API Reference Migration Guides Workbox on GitHub
Workbox
Service worker overview A service worker's life Strategies for service worker caching What is Workbox?
Expectations around service worker deployment Removing buggy service workers Improving the service worker development experience Troubleshooting and logging Different service worker strategies for different architectures Service workers and the application shell model Navigation Preload for Network-first HTML Faster multipage applications with streams Precaching dos and don'ts Understanding storage quota
The ways of Workbox Precaching with Workbox Using Workbox without precaching Framework integrations
Using workbox-window Caching resources during runtime Forcing a network timeout Access caches from the window Serving cached audio and video Managing fallback responses Handling service worker updates with immediacy Retrying requests when back online Using plugins
Workbox Modules API Reference Migration Guides Workbox on GitHub

workbox-recipes

    Summary

    Types

    GoogleFontCacheOptions

    Properties

    • cachePrefix

      string optional

    • maxAgeSeconds

      number optional

    • maxEntries

      number optional

    ImageCacheOptions

    Properties

    • cacheName

      string optional

    • matchCallback

      RouteMatchCallback optional

    • maxAgeSeconds

      number optional

    • maxEntries

      number optional

    • plugins

      WorkboxPlugin[] optional

    • warmCache

      string[] optional

    OfflineFallbackOptions

    Properties

    • fontFallback

      string optional

    • imageFallback

      string optional

    • pageFallback

      string optional

    PageCacheOptions

    Properties

    • cacheName

      string optional

    • matchCallback

      RouteMatchCallback optional

    • networkTimeoutSeconds

      number optional

    • plugins

      WorkboxPlugin[] optional

    • warmCache

      string[] optional

    StaticResourceOptions

    Properties

    WarmStrategyCacheOptions

    Properties

    Methods

    googleFontsCache

    workbox-recipes.googleFontsCache(
      options?: GoogleFontCacheOptions,
    )

    An implementation of the [Google fonts]https://developers.google.com/web/tools/workbox/guides/common-recipes#google_fonts caching recipe

    Parameters

    imageCache

    workbox-recipes.imageCache(
      options?: ImageCacheOptions,
    )

    An implementation of the [image caching recipe]https://developers.google.com/web/tools/workbox/guides/common-recipes#caching_images

    Parameters

    offlineFallback

    workbox-recipes.offlineFallback(
      options?: OfflineFallbackOptions,
    )

    An implementation of the [comprehensive fallbacks recipe]https://developers.google.com/web/tools/workbox/guides/advanced-recipes#comprehensive_fallbacks. Be sure to include the fallbacks in your precache injection

    Parameters

    pageCache

    workbox-recipes.pageCache(
      options?: PageCacheOptions,
    )

    An implementation of a page caching recipe with a network timeout

    Parameters

    staticResourceCache

    workbox-recipes.staticResourceCache(
      options?: StaticResourceOptions,
    )

    An implementation of the [CSS and JavaScript files recipe]https://developers.google.com/web/tools/workbox/guides/common-recipes#cache_css_and_javascript_files

    Parameters

    warmStrategyCache

    workbox-recipes.warmStrategyCache(
      options: WarmStrategyCacheOptions,
    )

    Parameters

    This site uses cookies to deliver and enhance the quality of its services and to analyze traffic. If you agree, cookies are also used to serve advertising and to personalize the content and advertisements that you see. Learn more about our use of cookies.