Skip to content
Experimental WebAPI

ServiceWorker

Types

client

The Client interface represents an executable context such as a Worker, or a SharedWorker. Window clients are represented by the more-specific WindowClient. See Client on MDN

type client = {id: string, url: string}

Record fields

id
string

Read more on MDN

url
string

Read more on MDN

clients

The Clients interface provides access to Client objects. Access it via self.clients within a service worker. See Clients on MDN

type clients

See NavigationPreloadManager on MDN

type navigationPreloadManager = private {}
type navigationPreloadState = {
  mutable enabled?: bool,
  mutable headerValue?: string,
}

Record fields

option< bool >
option< string >

registrationOptions

type registrationOptions = {
  mutable scope?: string,
  mutable type_?: WebWorkersTypes.workerType,
  mutable updateViaCache?: serviceWorkerUpdateViaCache,
}

Record fields

scope
option< string >
type_
option< WebWorkersTypes.workerType >
updateViaCache
option< serviceWorkerUpdateViaCache >

requestInfo

type requestInfo = unknown

serviceWorker

This WebApiServiceWorker API interface provides a reference to a service worker. Multiple browsing contexts (e.g. pages, workers, etc.) can be associated with the same service worker, each through a unique WebApiServiceWorker object. See WebApiServiceWorker on MDN

type serviceWorker = private {
  scriptURL: string,
  state: serviceWorkerState,
}

Record fields

scriptURL
string

Read more on MDN

state
serviceWorkerState

Read more on MDN

serviceWorkerContainer

The ServiceWorkerContainer interface of the WebApiServiceWorker API provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister and update service workers, and access the state of service workers and their registrations. See ServiceWorkerContainer on MDN

type serviceWorkerContainer = private {
  controller: Null.t<serviceWorker>,
  ready: promise<serviceWorkerRegistration>,
}

Record fields

controller
Null.t< serviceWorker >

Read more on MDN

ready
promise< serviceWorkerRegistration >

Read more on MDN

serviceWorkerGlobalScope

The ServiceWorkerGlobalScope interface of the Service Worker API represents the global execution context of a service worker. See ServiceWorkerGlobalScope on MDN

type serviceWorkerGlobalScope = private {
  caches: WebWorkersTypes.cacheStorage,
  crossOriginIsolated: bool,
  clients: clients,
  registration: serviceWorkerRegistration,
}

Record fields

caches
WebWorkersTypes.cacheStorage

Read more on MDN

crossOriginIsolated
bool

Read more on MDN

clients
clients

Read more on MDN

registration
serviceWorkerRegistration

Read more on MDN

serviceWorkerRegistration

This WebApiServiceWorker API interface represents the service worker registration. You register a service worker to control one or more pages that share the same origin. See ServiceWorkerRegistration on MDN

type serviceWorkerRegistration = private {
  installing: Null.t<serviceWorker>,
  waiting: Null.t<serviceWorker>,
  active: Null.t<serviceWorker>,
  navigationPreload: navigationPreloadManager,
  scope: string,
  updateViaCache: serviceWorkerUpdateViaCache,
  pushManager: PushTypes.pushManager,
}

Record fields

installing
Null.t< serviceWorker >

Read more on MDN

waiting
Null.t< serviceWorker >

Read more on MDN

active
Null.t< serviceWorker >

Read more on MDN

navigationPreload
navigationPreloadManager

Read more on MDN

scope
string

Read more on MDN

updateViaCache
serviceWorkerUpdateViaCache

Read more on MDN

pushManager
PushTypes.pushManager

Read more on MDN

serviceWorkerState

type serviceWorkerState =
  | @as("activated") Activated
  | @as("activating") Activating
  | @as("installed") Installed
  | @as("installing") Installing
  | @as("parsed") Parsed
  | @as("redundant") Redundant

serviceWorkerUpdateViaCache

type serviceWorkerUpdateViaCache =
  | @as("all") All
  | @as("imports") Imports
  | @as("none") None

windowClient

The WindowClient interface of the WebApiServiceWorker API represents the scope of a service worker client that is a document in a browsing context, controlled by an active worker. See WindowClient on MDN

type windowClient = {id: string, url: string}

Record fields

id
string

Read more on MDN

url
string

Read more on MDN

workerType

type workerType =
  | @as("classic") Classic
  | @as("module") Module