KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

AbortController en AbortSignal: annulering aanvragen en de status uitlezen

Geef `controller.signal` door aan een bewerking die annulering ondersteunt, vraag die aan met `controller.abort()` en lees met `signal.aborted` de status van het signaal, niet de uitkomst van de bewerking.

Versie: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

const controller = new AbortController();
const signal = controller.signal;
const aborted = signal.aborted;

// Two call forms; choose one for the first abort:
controller.abort();
controller.abort(reason);

Maak een controller met new AbortController() en bewaar die in de code die beslist wanneer er geannuleerd wordt. De alleen-lezen instantie-eigenschap controller.signal geeft voor die controller altijd hetzelfde AbortSignal-object terug. Geef het door aan een API die het accepteert, bijvoorbeeld via fetch(url, { signal }). Meerdere bewerkingen kunnen één signaal delen als ze samen moeten worden geannuleerd.

signal.aborted is een alleen-lezen booleaanse eigenschap, geen methode. De beginwaarde is false. De eerste aanroep van controller.abort() of controller.abort(reason) verandert de status van het signaal synchroon in true en vuurt de abort-gebeurtenis af voordat de aanroep undefined teruggeeft. signal.reason bevat de opgegeven waarde; zonder argument of bij undefined bevat de eigenschap een DOMException met de naam AbortError.

Latere aanroepen vervangen de reden niet en vuren geen nieuwe gebeurtenis af. Je kunt het signaal niet resetten: maak voor een nieuwe annuleringscyclus een nieuwe controller. De statische methode AbortSignal.abort() werkt anders: die maakt een nieuw, al geannuleerd signaal in plaats van het signaal van een bestaande controller te wijzigen.

Annulering vereist medewerking van de bewerking. aborted === true beschrijft het signaal: het bevestigt niet dat de bewerking is gestopt en maakt afgerond werk niet ongedaan. Controleer in je eigen promise-gebaseerde API het signaal vóór de start, handel een latere abort-gebeurtenis af, wijs nog wachtende promises af met signal.reason en verwijder de listener bij normale voltooiing. Dit zijn webplatform-API’s, geen onderdeel van ECMAScript 2024; controleer de ondersteuning in je doelomgeving.

Voorbeelden

{
  const controller = new AbortController();
  const signal = controller.signal;

  console.log(`before: ${signal.aborted}`);
  signal.addEventListener("abort", () => {
    console.log(`event: ${signal.aborted}`);
  });

  controller.abort("superseded");
  controller.abort("ignored");
  console.log(`after: ${signal.aborted}, ${signal.reason}`);
}

Resultaat

before: false
event: true
after: true, superseded

De regel `event: true` laat zien dat de status al is gewijzigd wanneer de listener draait. De tweede aanroep vuurt geen nieuwe gebeurtenis af en vervangt de reden `superseded` niet.

Gerelateerde lessen

  • JavaScript · Les 4 · Gevorderd · Versie: 4

Bronnen