TaskController

TaskController()

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

Diese Schnittstelle erbt auch die Methoden ihres Elternteils, AbortController.

TaskController.setPriority()

Setzt die Priorität des signal des Controllers und damit die Priorität aller damit verbundenen Aufgaben. Dies benachrichtigt Beobachter über die Prioritätsänderung durch das Auslösen eines prioritychange-Ereignisses.

Diese Schnittstelle erbt auch die Eigenschaften ihres Elternteils, AbortController.

TaskController.signal Schreibgeschützt

Gibt eine TaskSignal-Objektinstanz zurück. Das Signal wird an Aufgaben übergeben, damit sie vom Controller abgebrochen oder umpriorisiert werden können. Die Eigenschaft wird von AbortController geerbt.

Zunächst 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 Event-Listener für prioritychange-Ereignisse hinzu (hier wird addEventListener() aufgerufen, aber wir könnten stattdessen einen Handler 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. Dieser gleiche Ansatz würde verwendet werden, wenn der Controller ein AbortController wäre.

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

Als nächstes posten wir die Aufgabe und übergeben das Controller-Signal im optionalen Argument. In diesem Fall ist die Aufgabe nur eine Pfeilfunktion, die das Versprechen auflöst, indem sie etwas Text zurückgibt. Wir verwenden then und catch, um zu behandeln, wenn die Aufgabe aufgelöst oder abgelehnt wird, wobei der Rückgabetext oder der Fehler in jedem Fall protokolliert wird. Beachten Sie, dass wir in einem späteren Codeblock die Aufgabe abbrechen, sodass tatsächlich nur der catch()-Block 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 mithilfe von TaskController.setPriority() ändern. Dies wird das zugehörige prioritychange-Ereignis auslösen.

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

Schließlich kann die Aufgabe durch Aufrufen 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