https://github.com/DockYard/ember-service-worker-cache-first

https://github.com/DockYard/ember-service-worker-cache-first

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/DockYard/ember-service-worker-cache-first
• Owner: DockYard
• License: mit
• Created: 2016-06-24T19:25:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-12-14T18:26:13.000Z (about 6 years ago)
• Last Synced: 2024-11-17T21:11:25.729Z (2 months ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 7
• Watchers: 12
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-ember - ember-service-worker-cache-first - A cache first Ember.js Service Worker plugin. (Packages / Service Workers)

README

        
# Ember Service Worker Cache First

**[ember-service-worker-cache-first is built and maintained by DockYard, contact us for expert Ember.js consulting](https://dockyard.com/ember-consulting)**.

_A cache first Ember Service Worker plugin_

This plugin fulfills a strategy of serving cached content first, and then loading a fresh version to store in the cache for the next request.

This strategy is sometimes also referred to as [stale while revalidate](https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/#stale-while-revalidate)

## F#$& my assets aren't updating in development mode

Turn on the "Update on reload" setting in the `Application > Service Workers`

menu in the Chrome devtools.

## Installation

```

ember install ember-service-worker-cache-first

```

## Configuration

The configuration is done in the `ember-cli-build.js` file:

```js

var EmberApp = require('ember-cli/lib/broccoli/ember-app');

module.exports = function(defaults) {

  var app = new EmberApp(defaults, {

    'esw-cache-first': {

      // RegExp patterns specifying which URLs to cache.

      patterns: [

        '/api/v1/(.+)',

        'https://cdn.example.com/assets/fonts/(.+)',

        'https://cdn.example.com/assets/images/((?!avatars/).+)'

      ],

      // changing this version number will bust the cache

      version: '1'

    }

  });

  return app.toTree();

};

```

## Authors

* [Marten Schilstra](http://twitter.com/martndemus)

## Versioning

This library follows [Semantic Versioning](http://semver.org)

## Want to help?

Please do! We are always looking to improve this library. Please see our

[Contribution Guidelines](https://github.com/dockyard/ember-service-worker-cache-first/blob/master/CONTRIBUTING.md)

on how to properly submit issues and pull requests.

## Legal

[DockYard](http://dockyard.com/), Inc. © 2016

[@dockyard](http://twitter.com/dockyard)

[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)