MDN self-hosted library · e01.org

TaskSignal: prioritychange event

Prioritized Task Scheduling API

no runnable cells web-api-event upstream source

Prioritized Task Scheduling API

The prioritychange event is sent to a TaskSignal if its priority is changed.

Syntax

Use the event name in addEventListener():

addEventListener("prioritychange", (event) => { })

Alternatively, assign to the event handler property of the interface:

onprioritychange = (event) => { }

Event type

A TaskPriorityChangeEvent. Inherits from Event.

TaskPriorityChangeEvent

Examples

The example below shows how to listen for the prioritychange event on a TaskSignal.

```html hidden


```css hidden
#log {
  min-height: 70px;
  width: 95%;
}

``js hidden let log = document.getElementById("log"); function myLog(text) { log.textContent +=${text}\n`; }


First we create a controller, and add an event listener to its signal.
When handling the event we use previousPriority on the event to get the original priority and TaskSignal.priority on the event target to get the new/current priority.

The task is then posted, passing in the signal, and then we immediately change the priority.

```js
if ("scheduler" in this) {
  // Declare a TaskController, setting its signal priority to 'user-blocking'
  const controller = new TaskController({ priority: "user-blocking" });

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

  // Post task using the controller's signal.
  // The signal priority sets the initial priority of the task
  scheduler.postTask(
    () => {
      myLog("Task 1");
    },
    { signal: controller.signal },
  );

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

[!NOTE] The code above uses a custom logging function myLog() to log to the text area below. This is hidden as it isn't relevant to the example.

The output below demonstrates shows that the task's priority changed from user-blocking to background. This happens before the task is executed, but could also happen when the task is running.

400px

Specifications

Browser compatibility