W3cubDocs

/Web APIs

NavigateEvent: signal property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The signal read-only property of the NavigateEvent interface returns an AbortSignal, which will become aborted if the navigation is cancelled (e.g. by the user pressing the browser's "Stop" button, or another navigation starting and thus cancelling the ongoing one).

Value

An AbortSignal object.

Examples

The general idea here is that the signal property can be passed to an associated fetch() operation so that if the navigation is cancelled, the fetch() operation can be safely aborted, avoiding wasting bandwidth on fetches that are no longer needed.

js

navigation.addEventListener("navigate", (event) => {
  event.intercept({
    async handler() {
      // ...

      await fetch(`/img/some-image.jpg`, { signal: event.signal });

      // ...
    },
  });
});

Note: See Example: next/previous buttons for a more detailed example.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
signal 102 102 No No No No 102 102 No 70 No 19.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/NavigateEvent/signal