MDN self-hosted library · e01.org

NavigateEvent: signal property

Navigation API

Open notebook · 1 cells web-api-instance-property upstream source

Navigation API

The signal read-only property of the NavigateEvent interface returns an AbortSignal, which will become aborted if the navigation is canceled (e.g., by the user pressing the browser's "Stop" button, or another navigation starting and thus canceling 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 canceled, the fetch() operation can be safely aborted, avoiding wasting bandwidth on fetches that are no longer needed.

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

See also