A collection of libraries that help enhance your existing service worker by providing commonly-needed functionality.
A monorepo
approach is used to manage multiple helper libraries, each of which is versioned
and published to npm independently.
A service worker implementation of the behavior defined in a page's App Cache manifest.
Install: npm install --save-dev sw-appcache-behavior
Learn More: About • Demo • API
A service worker helper library to retry offline Google Analytics requests when a connection is available.
Install: npm install --save-dev sw-offline-google-analytics
Learn More: About • Demo • API
Tasks are run via gulp, and assume that you have a
globally installed gulp binary (npm install -g gulp) as well as
a locally installed set of node_module dependencies (npm install from within
the top-level directory).
When running a task, an optional --project=project-name parameter can be used.
For example, gulp build:watch --project=sw-appcache-behavior.
By default the task will be run against all projects.
New projects should be created as sub-directories of projects,
following the basic layout of the existing projects. It's recommended that each
library adopts the sw- prefix, for consistency.
Always include the following:
src/- raw source files, with JSDoc-formatted comments.build.js- Shouldexporta function that performs all the steps needed to produce a ready-to-use library in localbuild/directory.test/*.js- One or more Mocha test suites.package.json- Thenpmmetadata for the library. Each library is versioned independently.
A demo/ directory is optional but encouraged. The project's README.md file
will be automatically generated based on a template using the metadata found in
the JSDoc comments.
Please read the guide to contributing prior to filing any pull requests.
Copyright 2016 Google, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.