hub / github.com/GoogleChrome/workbox

github.com/GoogleChrome/workbox @v7.4.1 sqlite

repository ↗ · DeepWiki ↗ · release v7.4.1 ↗

826 symbols 2,314 edges 515 files 254 documented · 31%

README

Welcome to Workbox!

Workbox is a collection of JavaScript libraries for Progressive Web Apps.

Documentation

Maintenance update

Workbox is a powerful library originally developed by members of Chrome's developer relations team to facilitate the creation of Progressive Web Apps and to improve the offline experience of web applications. It offers a suite of tools and strategies for efficiently caching and serving web assets, managing service workers, and handling offline scenarios. Workbox simplifies the implementation of common caching patterns and provides developers with a comprehensive toolkit to build robust, resilient web applications. From now on, Chrome's Aurora team will be the new owners of Workbox.

Contributing

Development happens in the open on GitHub. We're thankful to the community for contributing any improvements.

Please read the guide to contributing for information about setting up your environment and other requirements prior to filing any pull requests.

License

MIT. See LICENSE for details.

Extension points exported contracts — how you extend this code

WorkboxPlugin (Interface)

(no doc) [8 implementers]

packages/workbox-core/src/types.ts

ManifestTransformResultWithWarnings (Interface)

* A `ManifestTransform` function can be used to modify the modify the `url` or * `revision` properties of some or all o

packages/workbox-build/src/lib/transform-manifest.ts

CacheStorage (Interface)

(no doc) [2 implementers]

infra/type-overrides.d.ts

InstallResult (Interface)

(no doc)

packages/workbox-precaching/src/_types.ts

StaticResourceOptions (Interface)

(no doc)

packages/workbox-recipes/src/staticResourceCache.ts

SyncManager (Interface)

(no doc)

packages/workbox-background-sync/src/index.ts

NavigationPreloadState (Interface)

(no doc)

packages/workbox-navigation-preload/src/index.ts

StreamsHandlerCallback (Interface)

(no doc)

packages/workbox-streams/src/strategy.ts

Core symbols most depended-on inside this repo

get

called by 154

packages/workbox-sw/controllers/WorkboxSW.mjs

addEventListener

called by 133

packages/workbox-window/src/utils/WorkboxEventTarget.ts

run

called by 124

infra/pr-bot/aggregate-size-plugin.js

match

called by 121

infra/type-overrides.d.ts

called by 105

test/workbox-sw/sw/controllers/test-WorkboxSW.mjs

spyOnEvent

called by 80

infra/testing/helpers/extendable-event-utils.mjs

keys

called by 79

infra/type-overrides.d.ts

registerRoute

called by 73

packages/workbox-routing/src/Router.ts

Shape

Function 337

Method 237

Class 135

Interface 116

Enum 1

Languages

TypeScript100%

Modules by API surface

packages/workbox-core/src/types.ts34 symbols

test/workbox-strategies/sw/test-Strategy.mjs28 symbols

packages/workbox-background-sync/src/Queue.ts22 symbols

infra/type-overrides.d.ts18 symbols

packages/workbox-strategies/src/StrategyHandler.ts17 symbols

packages/workbox-precaching/src/PrecacheController.ts16 symbols

packages/workbox-build/src/types.ts16 symbols

packages/workbox-background-sync/src/lib/QueueDb.ts15 symbols

packages/workbox-build/src/lib/validate-options.ts14 symbols

packages/workbox-window/src/Workbox.ts13 symbols

packages/workbox-routing/src/Router.ts13 symbols

packages/workbox-expiration/src/models/CacheTimestampsModel.ts13 symbols

Dependencies from manifests, versioned

@apideck/better-ajv-errors0.3.1 · 1×

@babel/cli7.24.1 · 1×

@babel/core7.24.4 · 1×

@babel/preset-env7.24.4 · 1×

@babel/runtime7.11.2 · 1×

@google-cloud/storage5.20.5 · 1×

@octokit/rest19.0.13 · 1×

@rollup/plugin-babel6.1.0 · 1×

@rollup/plugin-commonjs29.0.0 · 1×

@rollup/plugin-multi-entry7.1.0 · 1×

@rollup/plugin-node-resolve16.0.3 · 1×

@rollup/plugin-replace6.0.3 · 1×

For agents

$ claude mcp add workbox \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact