TaskController

Konstruktor

TaskController()

Erstellt ein neues TaskController-Objekt, wobei optional die Priorität des zugehörigen signal angegeben wird.

Instanzmethoden

Dieses Interface übernimmt auch die Methoden seines Elternteils, AbortController.

TaskController.setPriority()

Setzt die Priorität des signal des Controllers und damit die Priorität aller Aufgaben, mit denen es verbunden ist. Diese Benachrichtigt die Beobachter der Prioritätsänderung durch das Auslösen eines prioritychange Ereignisses.

Instanzeigenschaften

Dieses Interface übernimmt auch die Eigenschaften seines Elternteils, AbortController.

TaskController.signal Schreibgeschützt

Gibt eine Instanz des TaskSignal Objekts zurück. Das Signal wird an Aufgaben übergeben, damit sie vom Controller abgebrochen oder neu priorisiert werden können. Diese Eigenschaft wird von AbortController geerbt.

Beispiele

Zuerst erstellen wir einen Task-Controller und setzen die Priorität seines zugehörigen Signals auf user-blocking.

// Create a TaskController, setting its signal priority to 'user-blocking'
const controller = new TaskController({ priority: "user-blocking" });

Dann fügen wir einen Ereignis-Listener für prioritychange Ereignisse hinzu (hier wird addEventListener() aufgerufen, aber wir könnten stattdessen einen Handler zu TaskSignal.onprioritychange zuweisen). Der Handler verwendet previousPolicy beim Ereignis, um die ursprüngliche Priorität zu erhalten, und TaskSignal.priority beim Ereignisziel, um die neue Priorität zu erhalten.

// Listen for 'prioritychange' events on the controller's signal.
controller.signal.addEventListener("prioritychange", (event) => {
  const previousPriority = event.previousPriority;
  const newPriority = event.target.priority;
  console.log(`Priority changed from ${previousPriority} to ${newPriority}.`);
});

Wir können auch auf abort Ereignisse wie unten gezeigt hören. Diese Vorgehensweise würde auch verwendet, wenn der Controller ein AbortController wäre.

controller.signal.addEventListener(
  "abort",
  (event) => {
    console.log("Task aborted");
  },
  { once: true },
);

Als Nächstes veröffentlichen wir die Aufgabe und übergeben das Controllersignal im optionalen Argument. In diesem Fall ist die Aufgabe einfach eine Pfeilfunktion, die das Versprechen durch Zurückgeben eines Textes auflöst. Wir verwenden then und catch, um zu behandeln, wann die Aufgabe aufgelöst oder abgelehnt wird, und protokollieren den Rückgabetext oder den Fehler in jedem Fall. Beachten Sie, dass wir in einem späteren Codeblock die Aufgabe abbrechen, sodass nur der catch()-Block tatsächlich ausgeführt wird!

// Post task using the controller's signal.
// The signal priority sets the initial priority of the task
scheduler
  .postTask(() => "Task execute", { signal: controller.signal })
  .then((taskResult) => {
    console.log(`${taskResult}`);
  }) // Aborted (won't run)
  .catch((error) => {
    console.log(`Catch error: ${error}`);
  }); // Log error

Wir können den Controller verwenden, um die Aufgabe zu verwalten. Hier können wir die Priorität mit TaskController.setPriority() ändern. Dadurch wird das zugehörige prioritychange Ereignis ausgelöst.

// Change the priority to 'background' using the controller
controller.setPriority("background");

Schließlich kann die Aufgabe durch Aufruf von abort() am Controller abgebrochen werden.

// Abort the task
controller.abort();

Die Konsolenausgabe dieses Beispiels wäre:

The priority changed from user-blocking to background.
Task aborted
Catch error: AbortError

Spezifikationen

Browser-Kompatibilität