Registry / devops / ember-service-worker-cache-first

ember-service-worker-cache-first

library0.6.3jsnpmunverified

An Ember Service Worker plugin that implements a cache-first (stale-while-revalidate) strategy for serving cached content, falling back to network updates. Version 0.6.3 is current, with no recent releases; requires Node 6+ and Ember Service Worker. Alternative to other caching plugins with regex-based URL pattern matching and versioning for cache busting. Built by DockYard.

devops

npm install ember-service-worker-cache-first

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · EMBER-SERVICE-WORK

ember-service-worker-cache-first

devopsjavascriptv0.6.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

esw-cache-first config

✓ // In ember-cli-build.js let app = new EmberApp(defaults, { 'esw-cache-first': { patterns: ['/api/(.+)'], version: '1' } });

Configuration is done in ember-cli-build.js, not imported. The plugin is an Ember addon that auto-registers.

Installs the addon and configures URL patterns and version for cache-first service worker strategy.

// Install the addon ember install ember-service-worker-cache-first // Configure in ember-cli-build.js let EmberApp = require('ember-cli/lib/broccoli/ember-app'); module.exports = function(defaults) { let app = new EmberApp(defaults, { 'esw-cache-first': { patterns: [ '/api/v1/(.+)', 'https://cdn.example.com/assets/fonts/(.+)', 'https://cdn.example.com/assets/images/((?!avatars/).+)' ], version: '1' } }); return app.toTree(); };

Debug

Known issues

deprecatedPackage has not been updated since 2017 and may not work with latest Ember versions.

fix

Consider using an alternative caching plugin or updating manually.

affects: >=0.6.3

gotchaAssets may not update in development mode due to service worker caching.

fix

Enable 'Update on reload' in Chrome DevTools > Application > Service Workers.

affects: *

breakingRequires ember-service-worker addon to be installed.

fix

Run `ember install ember-service-worker` before this plugin.

affects: *

breakingNode engines specified as '6.* || 8.* || >= 10.*' — may break on Node 12+ due to engine constraint.

fix

Override engines in package.json or use a compatible Node version.

affects: >=0.6.3

gotchaPatterns are RegExp strings, not actual RegExp objects. Double escaping required for backslashes.

fix

Use string patterns like '/api/(.+)' not RegExp literals.

affects: *

Errors

Common errors & fixes

Ember CLI requires Node.js 6 or higher

Old Node.js version

fix

Upgrade Node.js to version 6 or higher.

Missing ember-service-worker addon

Peer dependency not installed

fix

Run `ember install ember-service-worker` first.

Patterns not matching URLs

RegExp patterns not escaped correctly in ember-cli-build.js

fix

Use double backslashes for literal backslashes in the string pattern, e.g., '/api/v1/(.+)'.

Upgrade

Version history

0.6.3latest on npm

Audit

Dependencies

ember-service-workerrequiredpeer dependency that provides the service worker infrastructure

Agent activity

2 hits · last 30 days

node

Resources

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

packageember-service-worker-cache-first ↗

homepagehttps://github.com/DockYard/ember-service-worker-cache-first#readme ↗