Window: scheduler property
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Thescheduler
read-only property of theWindow
interface is the entry point for using thePrioritized Task Scheduling API.
It returns aScheduler
object instance containingpostTask()
andyield()
methods that can be used to schedule prioritized tasks.
Value
Examples
The code below shows a very basic use of the property and its associated interface.It demonstrates how to check that the property exists and then posts a task that returns a promise.
js
// Check if the prioritized task API is supportedif ("scheduler" in window) { // Callback function - "the task" const myTask = () => "Task 1: user-visible"; // Post task with default priority: 'user-visible' (no other options) // When the task resolves, Promise.then() logs the result. window.scheduler .postTask(myTask) // Handle resolved value .then((taskResult) => console.log(`${taskResult}`)) // Handle error or abort .catch((error) => console.log(`Error: ${error}`));} else { console.log("Feature: NOT Supported");}
For comprehensive example code showing to use the API seePrioritized Task Scheduling API > Examples.
Specifications
Specification |
---|
Prioritized Task Scheduling # dom-windoworworkerglobalscope-scheduler |