Service Worker API for Dart #

Dart-y wrappers for the ServiceWorker APIs.

Warning: the API is experimental, and subject to change.

Service Workers #

A service worker is an event-driven worker registered against an origin and a path. It takes the form of a JavaScript file that can control the web page/site it is associated with, intercepting and modifying navigation and resource requests, and caching resources in a very granular fashion to give you complete control over how your app behaves in certain situations (the most obvious one being when the network is not available.)

A service worker is run in a worker context: it therefore has no DOM access, and runs on a different thread to the main JavaScript that powers your app, so it is not blocking. It is designed to be fully async; as a consequence, APIs such as synchronous XHR and localStorage can't be used inside a service worker.

W3C draft: https://www.w3.org/TR/service-workers/
Mozilla doc: https://developer.mozilla.org/en/docs/Web/API/Service_Worker_API

Quickstart #

Register the Service Worker from your application script, like in example/web/main.dart:

import 'package:service_worker/window.dart' as sw;

void main() {
  if (sw.isSupported) {
    sw.register('sw.dart.js');
  } else {
    print('ServiceWorkers are not supported.');
  }
}

Write the Service Worker in a separate script, like in example/web/sw.dart:

import 'package:service_worker/service_worker.dart';

void main(List<String> args) {
  onInstall.listen((event) {
    print('ServiceWorker installed.');
  });
}

0.2.3 #

Support Dart 2 stable.

0.2.2 #

Fix runtime errors casting List

0.2.1 #

Fixed a use of dynamic as bottom by adding type parameters to futureToPromise.

0.2.0 #

Updated to work with dart:html for 2.0.0-dev.40.0:
- ExtendableEvent, FetchEvent removes deepPath or scoped members.
- Added composed and composedPath members.
Migrate off deprecated APIs from the core libraries.
Fixed a strong-mode cast warning that will become an error soon.

0.1.2 #

Style cleanup: preferring single quotes.
Removed generic type comments.

0.1.1 #

Remove package:func dependency.

0.1.0 #

Upgraded dependencies.

0.0.16 #

Remove 'implements' from JS facade methods, as it seems to break with dart2js.

0.0.15 #

Implement new methods for classes that implement Event.

0.0.14 #

Don't return ServiceWorker instances when the underlying JS object is null.
Mask types from JS facade, to prevent type check errors in Dartium.

0.0.13 #

expose Notification.close()
expose ServiceWorkerClientsMatchOptions

0.0.12 #

expose keys in PushSubscription

0.0.11 #

expose ServiceWorkerRegistration.jsObject
fix a few typing bug

0.0.10 #

export ShowNotificationAction

0.0.9 #

PushManager.hasPermission() is a deprecated API and it doesn't work in Chrome anymore, clients should use permissionState() instead.

0.0.8 #

ServiceWorkerClient.postMessage() to use List as transfer objects parameter.
ServiceWorker.postMessage(): any Transferable object can be set, not only MessagePorts.

0.0.7 #

removed Worker interface from JS facade, solves Dartium issue

0.0.1 - 0.0.6 #

0.0.6 #

fixed Cache.keys()

0.0.5 #

add support for WorkerLocation

0.0.4 #

fetch() with RequestInit
support for Headers cloning

0.0.3 #

fix Cache.put() signature

0.0.2 #

top-level fields and methods

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  service_worker: ^0.2.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:service_worker/service_worker.dart';

Version	Uploaded	Documentation	Archive
0.2.3	Aug 6, 2018
0.2.2	Jun 27, 2018
0.2.1	Apr 19, 2018
0.2.0	Mar 21, 2018
0.1.2	Feb 5, 2018
0.1.1	Jan 10, 2018
0.1.0	Sep 29, 2017
0.0.16	Jul 1, 2017
0.0.15	Jun 15, 2017
0.0.14	May 11, 2017

All 23 versions...

Popularity: Describes how popular the package is relative to other packages. [more]	87
Health: Code health derived from static analysis. [more]	100
Maintenance: Reflects how tidy and up-to-date the package is. [more]	87
Overall: Weighted score of the above. [more]	91

Learn more about scoring.

We analyzed this package on Jun 19, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

Dart: 2.3.2
pana: 0.12.18

Platforms

Detected platforms: web

Primary library: package:service_worker/service_worker.dart with components: html, js.

Maintenance suggestions

The package description is too short. (-13 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and service_worker.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package	Constraint	Resolved
Direct dependencies
Dart SDK	>=2.0.0-dev.40.0 <3.0.0
js	^0.6.1	0.6.1+1

Dart pub

service_worker 0.2.3