NavigationPreloadManager: getState() method

Syntax

getState()

Parameters

None.

Return value

A Promise that resolves with an object that has the following properties:

enabled

true if preloading is enabled, and false otherwise.

headerValue

A string containing the value that will be sent in the Service-Worker-Navigation-Preload HTTP header following a preloading fetch(). This defaults to true unless the value was changed using NavigationPreloadManager.setHeaderValue().

Exceptions

InvalidStateError DOMException

There is no active worker associated with the registration to which this NavigationPreloadManager belongs.

Examples

The code below shows a request for the current state, made once the service worker is ready.

navigator.serviceWorker.ready
  .then((registration) => registration.navigationPreload.getState())
  .then((state) => {
    console.log(state.enabled); // boolean
    console.log(state.headerValue); // string
  })
  .catch((e) =>
    console.error(`NavigationPreloadManager not supported: ${e.message}`),
  );

Specifications

Browser compatibility