requestidlecallback-polyfill
v1.0.2
Published
requestIdleCallback Polyfill
Downloads
160,492
Maintainers
Readme
requestIdleCallback polyfill
Simple polyfill and d.ts for requestIdleCallback.
From MDN:
The
window.requestIdleCallback()
method queues a function to be called during a browser's idle periods. This enables developers to perform background and low priority work on the main event loop, without impacting latency-critical events such as animation and input response. Functions are generally called in first-in-first-out order; however, callbacks which have a timeout specified may be called out-of-order if necessary in order to run them before the timeout elapses.
You can call
requestIdleCallback()
within an idle callback function to schedule another callback to take place no sooner than the next pass through the event loop.
Install
npm i requestidlecallback-polyfill
or
yarn add requestidlecallback-polyfill
Usage
import 'requestidlecallback-polyfill';
// ...
window.requestIdleCallback(doSomething, {timeout: 2000});
Credits
- Code from developers.google.com
- Type definitions from rhysd/Mstdn
License
- Code: Apache License 2.0
- Type definitions: MIT