Scheduling: isInputPending() method

Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.

TheisInputPending() method of theScheduling interface allows you to check whether there are pending input events in the event queue, indicating that the user is attempting to interact with the page.

This feature can be useful in situations where you have a queue of tasks to run, and you want to yield to the main thread regularly to allow user interaction to occur so that the app is kept as responsive and performant as possible.isInputPending() allows you to yield only when there is input pending, rather than having to do it at arbitrary intervals.

Warning:TheisInputPending() method has been superseded by features available on theScheduler interface such asyield(), which are better designed for addressing scheduling tasks. SeeDon't useisInputPending() for more details.

isInputPending() is called usingnavigator.scheduling.isInputPending().

Syntax

isInputPending()isInputPending(options)

Parameters

optionsOptional

An object providing options. Currently, the only option is:

includeContinuousOptional: A boolean, which isfalse by default. If set totrue, it indicates that continuous events should be considered when checking for pending input. Continuous events are trusted events (events dispatched by the browser) that are fired successively, such asmousemove,wheel,touchmove,drag,pointermove, andpointerrawupdate.

Return value

A boolean that indicates whether there are pending input events in the event queue (true) or not (false).

Examples

We can useisInputPending() inside a task runner structure to run theyield() function only when the user is attempting to interact with the page:

function yield() {  return new Promise((resolve) => {    setTimeout(resolve, 0);  });}async function main() {  // Create an array of functions to run  const tasks = [a, b, c, d, e];  while (tasks.length > 0) {    // Yield to a pending user input    if (navigator.scheduling.isInputPending()) {      await yield();    } else {      // Shift the first task off the tasks array      const task = tasks.shift();      // Run the task      task();    }  }}

This allows you to avoid blocking the main thread when the user is actively interacting with the page, potentially providing a smoother user experience. However, by only yielding when necessary, we can continue running the current task when there are no user inputs to process. This also avoids tasks being placed at the back of the queue behind other non-essential browser-initiated tasks that were scheduled after the current one.