NavigateEvent.signal

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.

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

Specification
Navigation API
# dom-navigateevent-signal

Browser compatibility

BCD tables only load in the browser

See also