ServiceWorkerContainer

ServiceWorker APIのServiceWorkerContainerインターフェースは、 ネットワークエコシステム内の全体を包むユニットとして、サービスワーカーを表すオブジェクトを提供します。このユニットは、サービスワーカーの登録、登録の解除、更新のための機能や、サービスワーカーの状態とそれらの登録状況にアクセスするための機能を持っています。

ここで最も重要なことは、それがServiceWorkerContainer.register()メソッドとServiceWorkerContainer.controllerプロパティを持っていることです。ServiceWorkerContainer.register()メソッドはサービスワーカーの登録に使用され、ServiceWorkerContainer.controllerプロパティは、現在のページが動的にコントロールされるかどうかを決定するために使用されます。

プロパティ

ServiceWorkerContainer.controller 読取専用

アクティブな状態の（ServiceWorker.stateがactivatedを返す状態の）ServiceWorkerオブジェクトが存在する場合、そのServiceWorkerオブジェクトを返します（ServiceWorkerRegistration.activeが返すものと同じオブジェクトです。）。 このプロパティは、ページの再読み込み(Shift + refresh)の間や、アクティブなワーカーが存在しない場合にnullを返します。

ServiceWorkerContainer.ready 読取専用

サービスワーカーがアクティブになるまでコードの実行を遅らせる方法を提供します。 このプロパティはPromiseを返します。 返されるPromiseはrejectせず、現在のページにひもづいているServiceWorkerRegistrationがServiceWorkerRegistration.activeなワーカーを持つまで無期限に待ち続けます。 条件が満たされると、ServiceWorkerRegistrationとともにresolveします。

イベントハンドラ

ServiceWorkerContainer.oncontrollerchange

controllerchangeイベントによって（ドキュメントにひもづいているServiceWorkerRegistrationが新しいアクティブ（active）なワーカーを手に入れたときに）発火します。

ServiceWorkerContainer.onerror

ひもづいているサービスワーカー内でerrorイベントが発生したときに発火します。

ServiceWorkerContainer.onmessage

messageイベントが発生したときに（MessagePort.postMessage()の呼び出しなどによってServiceWorkerContainerオブジェクトにメッセージが渡ったときに）発火します。

メソッド

ServiceWorkerContainer.register() 

渡されたスクリプトURLをもとにServiceWorkerRegistrationを作成、または更新します。

ServiceWorkerContainer.getRegistration()

提供されたドキュメントURLと一致するスコープを持ったServiceWorkerRegistrationオブジェクトを取得します。 もしこのメソッドがServiceWorkerRegistrationを返せない場合、Promiseを返します。

ServiceWorkerContainer.getRegistrations()

Returns all ServiceWorkerRegistration objects associated with a ServiceWorkerContainer in an array.  If the method can't return ServiceWorkerRegistration objects, it returns a Promise. 

Examples

The example below first checks to see if the browser supports service workers. If supported, the code registers the service worker and determines if the page is actively controlled by the service worker. If it isn't, it prompts the user to reload the page so the service worker can take control. The code also reports any registration failures.

if ('serviceWorker' in navigator) {
  // Register a service worker hosted at the root of the
  // site using the default scope.
  navigator.serviceWorker.register('/sw.js').then(function(registration) {
    console.log('Service worker registration succeeded:', registration);

    // At this point, you can optionally do something 
    // with registration. See https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration
  }).catch(function(error) {
    console.log('Service worker registration failed:', error);
  });

  // Independent of the registration, let's also display
  // information about whether the current page is controlled
  // by an existing service worker, and when that
  // controller changes.

  // First, do a one-off check if there's currently a
  // service worker in control.
  if (navigator.serviceWorker.controller) {
    console.log('This page is currently controlled by:', navigator.serviceWorker.controller);
  }

  // Then, register a handler to detect when a new or
  // updated service worker takes control.
  navigation.serviceWorker.oncontrollerchange = function() {
    console.log('This page is now controlled by:', navigator.serviceWorker.controller);
  };
} else {
  console.log('Service workers are not supported.');
}

Specifications

Browser compatibility

[1] Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)

See also

• Using Service Workers
• Service workers basic code example
• Is ServiceWorker ready?
• Promise
• Using web workers